IPropertyBag::Read メソッド (oaidl.h)

  • [アーティクル]

名前付きプロパティを呼び出し元で初期化された VARIANT に読み取ります。

構文

HRESULT Read(
  LPCOLESTR pszPropName,
  VARIANT   *pVar,
  IErrorLog *pErrorLog
);

パラメーター

pszPropName

読み取るプロパティの名前のアドレス。 これを NULL にすることはできません。

pVar

出力時にプロパティ値を受け取る呼び出し元で初期化された VARIANT のアドレス。 関数は、返される前に VARIANT の型フィールドと値フィールドを設定します。 呼び出し元がエントリ時にフィールドを pVar->vt 初期化した場合、プロパティ バッグは対応する値をこの型に変更しようとします。 呼び出し元が VT_EMPTY に設定 pVar->vt されている場合、プロパティ バッグは便利な任意の型を使用できます。

pErrorLog

プロパティ バッグが読み取り中に発生したエラーを格納する呼び出し元のエラー ログのアドレス。 NULL を指定できます。その場合、呼び出し元はエラーを受け取りません。

戻り値

An HRESULT

注釈

Read メソッドは、pszPropName で指定されたプロパティを pVar の呼び出し元初期化 VARIANT に読み取るようにプロパティ バッグに指示します。 エラーは、 pErrorLog によって示されるエラー ログに記録されます。 別のオブジェクト ポインター (VT_UNKNOWN) を指定すると pVar->vt 、プロパティ バッグは pszPropName で記述されたオブジェクトを作成および初期化します。

E_NOTIMPLは、このインターフェイスを実装するオブジェクトがインターフェイスの機能全体をサポートする必要があるため、有効なリターン コードではありません。

要件

要件 値
サポートされている最小のクライアント Windows 10 ビルド 20348
サポートされている最小のサーバー Windows 10 ビルド 20348
Header oaidl.h