ITocEntry::GetDescriptionData メソッド (wmcodecdsp.h)

  • [アーティクル]

GetDescriptionData メソッドは、SetDescriptionData の呼び出しによってエントリに以前に関連付けられた説明データ ブロックを取得します。

構文

HRESULT GetDescriptionData(
  [in, out] DWORD *pdwDescriptionDataSize,
  [out]     BYTE  *pbtDescriptionData,
  [out]     GUID  *pGuidType
);

パラメーター

[in, out] pdwDescriptionDataSize

pbtDescriptionData が NULL の場合、これは説明データ ブロックのサイズ (バイト単位) を受け取る出力パラメーターです。 pbtDescriptionData が NULL でない場合、これは pbtDescriptionData が指す呼び出し元によって割り当てられたバッファーのサイズをバイト単位で指定する入力パラメーターです。

[out] pbtDescriptionData

NULL、または呼び出し元によって割り当てられたバッファーへのポインター。正常に完了すると、説明データ ブロックを受け取ります。

[out] pGuidType

説明データ ブロック内のデータ型を識別するグローバル一意識別子 (GUID) を受け取る変数へのポインター。 「解説」を参照してください。

戻り値

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

リターン コード 説明
S_OK
 メソッドが成功しました。
MF_E_BUFFERTOOSMALL
 pbtDescriptionData が NULL ではなく、コンテキスト ブロックが pdwDescriptionDataSize で指定されたサイズより大きい場合、メソッドはこのエラー コードを返します。 その場合、 pdwDescriptionDataSize は出力パラメーターとして機能し、必要なバッファーのサイズ (バイト単位) を受け取ります。

注釈

特定の時点で、特定のエントリに関連付けることができる説明データ ブロックは 1 つだけです。 ただし、さまざまな種類の説明データ ブロックを設計し、グローバル一意識別子 (GUID) を使用してブロックの各種類を識別することができます。 こうすることで、 SetDescriptionData を呼び出すときに、データ ブロックを特定の型としてマークできます。 GetDescriptionData を呼び出すときは、pGuidType で返される値を調べることで、取得したデータ ブロックの型を確認できます。

要件

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

こちらもご覧ください

ITocEntry

SetDescriptionData