IMFAttributes::GetAllocatedString メソッド (mfobjects.h)

  • [アーティクル]

キーに関連付けられたワイド文字列を取得します。 このメソッドは、文字列のメモリを割り当てます。

構文

HRESULT GetAllocatedString(
  [in]  REFGUID guidKey,
  [out] LPWSTR  *ppwszValue,
  [out] UINT32  *pcchLength
);

パラメーター

[in] guidKey

取得する値を識別する GUID。 属性の種類は MF_ATTRIBUTE_STRINGする必要があります。

[out] ppwszValue

キーが見つかり、値が文字列型の場合、このパラメーターは文字列のコピーを受け取ります。 呼び出し元は 、CoTaskMemFree を呼び出して、文字列のメモリを解放する必要があります。

[out] pcchLength

終端の NULL 文字を除き、文字列内の文字数を受け取ります。 このパラメーターは NULL にすることはできません。

戻り値

このメソッドは HRESULT を返します。 有効な値を次の表に示しますが、これ以外にもあります。

リターン コード 説明
S_OK
 メソッドが成功しました。
MF_E_ATTRIBUTENOTFOUND
 指定したキーが見つかりませんでした。
MF_E_INVALIDTYPE
 属性値は文字列ではありません。

注釈

文字列値を呼び出し元によって割り当てられたバッファーにコピーするには、 IMFAttributes::GetString メソッドを使用します。

このインターフェイスは、Windows Media Format 11 SDK 再頒布可能コンポーネントがインストールされている場合、次のプラットフォームで使用できます。

  • Service Pack 2 (SP2) 以降の Windows XP。
  • Windows XP Media Center Edition 2005 と KB900325 (Windows XP Media Center Edition 2005) とKB925766 (2006 年 10 月 Windows XP Media Center Edition の更新プログラムのロールアップ) がインストールされています。
メモ 以前のバージョンのドキュメントでは、 pcchLength パラメーターに NULL を指定できると誤って記載されています。 このパラメーターを NULL に設定すると、場合によっては成功することがありますが、保証されません。 呼び出し元は、このパラメーターに NULL 以外のポインターを渡す必要があります。
 

要件

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

こちらもご覧ください

属性とプロパティ

IMFAttributes

MF_ATTRIBUTE_TYPE