IWICComponentInfo::GetFriendlyName メソッド (wincodec.h)

  • [アーティクル]

コンポーネントのフレンドリ名を取得します。これは、コンポーネントの人間が判読できる表示名です。

構文

HRESULT GetFriendlyName(
  [in]      UINT  cchFriendlyName,
  [in, out] WCHAR *wzFriendlyName,
  [out]     UINT  *pcchActual
);

パラメーター

[in] cchFriendlyName

型: UINT

wzFriendlyName バッファーのサイズ。

[in, out] wzFriendlyName

種類: WCHAR*

コンポーネントのフレンドリ名を受け取るポインター。 文字列のロケールは、コーデックがインストール時にレジストリに書き込んだ値によって異なります。 組み込みコンポーネントの場合、これらの文字列は常に英語です。

[out] pcchActual

型: UINT*

コンポーネントのフレンドリ名の実際の長さを受け取るポインター。

戻り値

型: HRESULT

このメソッドは、成功すると S_OK を返します。 そうでない場合は、HRESULT エラー コードを返します。

注釈

cchFriendlyName が 0 で、wzFriendlyName が NULL の場合、必要なバッファー サイズは pccchActual で返されます。

要件

要件 値
サポートされている最小のクライアント WINDOWS XP と SP2、Windows Vista [デスクトップ アプリ |UWP アプリ]
サポートされている最小のサーバー Windows Server 2008 [デスクトップ アプリ | UWP アプリ]
対象プラットフォーム Windows
ヘッダー wincodec.h
Library Windowscodecs.lib
[DLL] Windowscodecs.dll