PSPropertyBag_ReadStrAlloc関数 (propsys.h)

プロパティ バッグ内のプロパティから文字列データ値を読み取り、読み取られた文字列にメモリを割り当てます。

構文

PSSTDAPI PSPropertyBag_ReadStrAlloc(
  [in]  IPropertyBag *propBag,
  [in]  LPCWSTR      propName,
  [out] PWSTR        *value
);

パラメーター

[in] propBag

種類: IPropertyBag*

プロパティが格納されているプロパティ バッグを表す IPropertyBag オブジェクトへのポインター。

[in] propName

種類: LPCWSTR

null で終わるプロパティ名文字列へのポインター。

[out] value

種類: PWSTR*

この関数が戻るとき、プロパティ バッグ内のプロパティからの文字列データ値へのポインターを格納し、読み取られた文字列にメモリを割り当てます。 PSPropertyBag_ReadStrAlloc関数の呼び出し元は、このパラメーターで CoTaskMemFree 関数を呼び出す必要があります。

戻り値

種類: HRESULT

この関数が成功すると、 S_OKが返されます。 そうでない場合は、HRESULT エラー コードを返します。

注釈

プロパティ バッグプロパティ関数 API は、ウィンドウ型と、プロパティ バッグ内の値を表すために使用される VARIANT 型の間で変換します。 これにより、プロパティ バッグの使用が容易になり、アプリケーションが簡素化され、一般的なコーディング エラーが回避されます。

要件