Метод IHttpContext::GetServerVariable
Извлекает определенную переменную сервера.
Синтаксис
virtual HRESULT GetServerVariable(
PCSTR pszVariableName,
PCWSTR * ppszValue,
DWORD * pcchValueLength
) = 0;
virtual HRESULT GetServerVariable(
PCSTR pszVariableName,
PCSTR * ppszValue,
DWORD * pcchValueLength
) = 0;
Параметры
pszVariableName
Указатель на строку, содержащую имя возвращаемой серверной переменной.
ppszValue
Адрес указателя на строковый буфер, получающий копию серверной переменной.
pcchValueLengthr
Указатель на буфер, получающий DWORD
длину ppszValue
параметра.
Возвращаемое значение
Объект HRESULT
. Допустимые значения включают, но не ограничиваются, значения, приведенные в следующей таблице.
Значение | Описание: |
---|---|
S_OK | Указывает, что операция выполнена успешно. |
ERROR_INVALID_INDEX | Указывает, что параметр недопустим. |
Комментарии
Метод GetServerVariable
извлекает переменную сервера, указанную параметром pszVariableName
, из текущего контекста HTTP и возвращает значение в буфере, на который ppszValue
указывает параметр . Серверная переменная, указанная параметром pszVariableName
, может быть пользовательской или переменной, определенной в разделе Запросы комментариев (RFC) 3875 , The Common Gateway Interface (CGI) version 1.1.
Примечание
Метод GetServerVariable
поддерживает возврат значений ANSI и Юникода с помощью перегруженных методов. Буфер, на который указывает параметр , ppszValue
может быть буфером PCWSTR
или PCSTR
.
Требования
Тип | Описание |
---|---|
клиент | — IIS 7.0 в Windows Vista — IIS 7.5 в Windows 7 — IIS 8.0 в Windows 8 — IIS 10.0 в Windows 10 |
Сервер | — IIS 7.0 в Windows Server 2008 — IIS 7.5 в Windows Server 2008 R2 — IIS 8.0 в Windows Server 2012 — IIS 8.5 в Windows Server 2012 R2 — IIS 10.0 в Windows Server 2016 |
Продукт | — IIS 7.0, IIS 7.5, IIS 8.0, IIS 8.5, IIS 10.0 — IIS Express 7.5, IIS Express 8.0, IIS Express 10.0 |
Заголовок | Httpserv.h |
См. также:
Интерфейс IHttpContext
Метод IHttpContext::SetServerVariable