IExplorerBrowser::SetPropertyBag メソッド (shobjidl_core.h)

プロパティ バッグの名前を設定します。

構文

HRESULT SetPropertyBag(
  [in] LPCWSTR pszPropertyBag
);

パラメーター

[in] pszPropertyBag

種類: LPCWSTR

プロパティ バッグの名前を含む、null で終わる定数の Unicode 文字列へのポインター。 クライアントのアプリケーションに固有のビューステート情報は、この名前を使用して保存 (永続化) されます。

戻り値

種類: HRESULT

このメソッドは、成功すると S_OK を返します。 そうでない場合は、HRESULT エラー コードを返します。

注釈

ExplorerBrowser は、関数 SHGetViewStatePropertyBag を呼び出すことによって、プロパティ バッグに格納されているプロパティを取得できます。 ExplorerBrowser は、レジストリにも格納 (永続化) されているこのプロパティ バッグに書き込みます。 永続化は、ExplorerBrowser が現在のビューを破棄するか、ナビゲーションを開始するか、破棄されたときに自動的に発生します。 これらのイベントのいずれかが発生すると、ユーザーによって変更された場合に備えて、ビュー ステートに関する情報が書き込まれます。

プロパティが格納されていない場合は、ExplorerBrowser の既定のビューステートが使用されます。 既定のビュー ステートは、ユーザーが特定の場所に対して設定したビュー ステート、または場所のビュー ステートが設定されていない場合 (ユーザーが変更していない場合)、既定のビュー ステートは、場所のファイルの種類 (ドキュメント、音楽、画像など) のテンプレートに基づいています。 すべてのエクスプローラーウィンドウでは、同じシーケンスを使用して既定のビューステートが決定されます。

要件

要件	値
サポートされている最小のクライアント	Windows Vista [デスクトップ アプリのみ]
サポートされている最小のサーバー	Windows Server 2008 [デスクトップ アプリのみ]
対象プラットフォーム	Windows
ヘッダー	shobjidl_core.h (Shobjidl.h を含む)