IToc::GetDescription メソッド (wmcodecdsp.h)

  • [アーティクル]

GetDescription メソッドは、目次の SetDescription の前の呼び出しによって設定された説明を取得します。

構文

HRESULT GetDescription(
  [in, out] WORD   *pwDescriptionSize,
  [out]     LPWSTR pwszDescription
);

パラメーター

[in, out] pwDescriptionSize

pwszDescription が NULL の場合、これは、説明を受け取るために必要なバッファーのサイズ (ワイド文字) を受け取る出力パラメーターです。 pwszDescription が NULL でない場合、これは pwszDescription によって指される呼び出し元によって割り当てられたバッファーのサイズをワイド文字で指定する入力パラメーターです。

[out] pwszDescription

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

戻り値

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

リターン コード 説明
S_OK
 メソッドが成功しました。
MF_E_BUFFERTOOSMALL
 pwszDescription が NULL ではなく、説明 (NULL ターミネータを含む) が pwDescriptionSize で指定されたサイズより大きい場合、メソッドはこのエラー コードを返します。 その場合、 pwDescriptionSize は出力パラメーターとして機能し、必要なバッファーのサイズを受け取ります。

要件

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

こちらもご覧ください

IToc