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:Common Gateway Interface (CGI) バージョン 1.1」で定義されている変数を指定できます。
注意
メソッドでは GetServerVariable 、オーバーロードされたメソッドを使用して ANSI 値と Unicode 値の両方を返す処理がサポートされています。 パラメーターがppszValue指すバッファーには、 または PCSTR バッファーのいずれかをPCWSTR指定できます。
要件
| Type | 説明 |
|---|---|
| Client | - Windows Vista 上の IIS 7.0 - Windows 7 上の IIS 7.5 - Windows 8 の IIS 8.0 - Windows 10の IIS 10.0 |
| サーバー | - Windows Server 2008 の IIS 7.0 - Windows Server 2008 R2 上の IIS 7.5 - Windows Server 2012 上の IIS 8.0 - Windows Server 2012 R2 上の IIS 8.5 - Windows Server 2016上の IIS 10.0 |
| 製品 | - 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 |
| Header | Httpserv.h |