IToc::Metode GetDescription (wmcodecdsp.h)

Metode GetDescription mengambil deskripsi, yang diatur oleh panggilan sebelumnya ke SetDescription, dari daftar isi.

Sintaks

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

Parameter

[in, out] pwDescriptionSize

Jika pwszDescriptionadalah NULL, ini adalah parameter output yang menerima ukuran, dalam karakter luas, dari buffer yang diperlukan untuk menerima deskripsi. Jika pwszDescription bukan NULL, ini adalah parameter input yang menentukan ukuran, dalam karakter luas, dari buffer yang dialokasikan pemanggil yang dialokasikan yang diarahkan oleh pwszDescription.

[out] pwszDescription

NULL, atau penunjuk ke buffer yang dialokasikan pemanggil yang, setelah berhasil diselesaikan, menerima deskripsi. Deskripsi dihentikan null.

Mengembalikan nilai

Metode mengembalikan HRESULT. Nilai yang mungkin termasuk, tetapi tidak terbatas pada, yang ada dalam tabel berikut.

Menampilkan kode	Deskripsi
S_OK	Metode berhasil.
MF_E_BUFFERTOOSMALL	Metode mengembalikan kode kesalahan ini jika pwszDescription bukan NULL dan deskripsi, termasuk terminator NULL-nya, lebih besar dari ukuran yang ditentukan oleh pwDescriptionSize. Dalam hal ini, pwDescriptionSize berfungsi sebagai parameter output dan menerima ukuran buffer yang diperlukan.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows Vista [hanya aplikasi desktop]
Server minimum yang didukung	Windows Server 2008 [hanya aplikasi desktop]
Target Platform	Windows
Header	wmcodecdsp.h
DLL	Wmvdspa.dll

Lihat juga

IToc