キャッシュ ポリシーの変数値を設定します。
構文
virtual HRESULT SetVaryByValue(
PCSTR pszValue
) = 0;
パラメーター
pszValue
追加するカスタム値を含む null で終わる文字列へのポインター。
\- または -
NULL。
戻り値
HRESULT。 有効な値を次の表に示しますが、これ以外にもあります。
| 値 | 説明 |
|---|---|
| S_OK | 操作が成功したことを示します。 |
| E_INVALIDARG | が NULL であることを pszValue 示します。 |
| ERROR_ARITHMETIC_OVERFLOW | の長さが pszValue 上限を超えたことを示します。 |
解説
要求イベントまたは応答イベントに登録する CHttpModule 派生クラスは、対応するvirtualメソッドのパラメーターとして IHttpContext ポインターを受け取ります。 変数の値を設定するには、 IHttpContext::GetResponse メソッド、 IHttpResponse::GetCachePolicy メソッド、最後に メソッドを SetVaryByValue 呼び出します。
SetVaryByValue 動作は実装によって異なります。 ガイドラインとして次の情報を使用する必要がありますが、すべてのシナリオで正しくない場合があります。
IHttpCachePolicy インターフェイスの現在の既定の実装者は、変数データを
private含むバッファーを宣言します。 実装者の構築中に、このバッファーは空に初期化されます。SetVaryByValueパラメーターが NULL の場合pszValueは、E_INVALIDARGを直ちに返します。 それ以外の場合、内部バッファーは、必要に応じて、 および null 終端文字のpszValue内容を保持するために拡張されます。 次にpszValue、 の後に null 終端文字が続き、このバッファーにコピーされます。 への呼び出しSetVaryByValue前のバッファー内のデータは、必要に応じて へのSetVaryByValue呼び出し中に上書きされます。
実装側の注意
パラメーターに関連付pszValueけられているデータは への呼び出しpszValue後に有効であるとは限らないため、IHttpCachePolicy 実装者はパラメーターをバッファーにコピーするSetVaryByValue必要があります。
呼び出し元に関する注意事項
IHttpCachePolicy クライアントは、null で終わる文字列を メソッドに渡す役割を SetVaryByValue 担います。 実装者が内部バッファーにコピーpszValueするためIHttpCachePolicy、クライアントは のSetVaryByValue呼び出し後に を破棄pszValueする責任もあります。
要件
| 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 |