IPerPropertyBrowsing::GetPredefinedValue メソッド (ocidl.h)

  • [アーティクル]

定義済みの文字列名に関連付けられている指定したプロパティの値を取得します。 このプロパティは、 IPerPropertyBrowsing::GetPredefinedStrings から返される定義済みの文字列名に関連付けられます。 定義済みの文字列は、 GetPredefinedStrings から返されるトークンによって識別されます。

構文

HRESULT GetPredefinedValue(
  [in]  DISPID  dispID,
  [in]  DWORD   dwCookie,
  [out] VARIANT *pVarOut
);

パラメーター

[in] dispID

定義済みの値が要求されるプロパティのディスパッチ識別子。

[in] dwCookie

返す値を識別するトークン。 トークンは、GetPredefinedStrings によって入力された pCaCookiesOut 配列で以前に返されました。

[out] pVarOut

プロパティの VARIANT 値へのポインター。

戻り値

このメソッドは、標準の戻り値E_INVALIDARG、E_OUTOFMEMORY、E_UNEXPECTED、および次の値を返すことができます。

リターン コード 説明
S_OK
 メソッドは正常に完了しました。
E_NOTIMPL
 このオブジェクトは、定義済みの文字列や定義済みの値をサポートしていません。
E_POINTER
 pVarOut のアドレスが無効です。 たとえば、 NULL である可能性があります。

注釈

呼び出し元へのメモ

呼び出し元は、 VARIANT に含まれる割り当てを解放する責任があります。 VARIANT の vt メンバーがVT_VARIANTされていない限り、呼び出し元は VariantClear への 1 回の呼び出しを使用してメモリを解放できます。 それ以外の場合、呼び出し元は、外側の VARIANT を解放する前に、含まれている VARIANT 値を再帰的に解放する必要があります。

実装者へのメモ

定義済みの名前と値のサポートは必要ありません。 オブジェクトでこれらの名前がサポートされていない場合は、このメソッドからE_NOTIMPLを返します。 このメソッドが実装されていない場合、 IPerPropertyBrowsing::GetPredefinedStrings も実装できません。

このメソッドは、 VARIANT 内に必要なメモリを割り当てます。

要件

要件 値
サポートされている最小のクライアント Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー ocidl.h

こちらもご覧ください

IPerPropertyBrowsing