Метод IToc::GetDescription (wmcodecdsp.h)

Статья
03/15/2023

Метод 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 выступает в качестве выходного параметра и получает размер требуемого буфера.

Код возврата

Описание

S_OK

Метод выполнен успешно.

MF_E_BUFFERTOOSMALL

Метод возвращает этот код ошибки, если pwszDescription не равно NULL , а описание, включая его признак конца NULL, больше размера, указанного в pwDescriptionSize. В этом случае pwDescriptionSize выступает в качестве выходного параметра и получает размер требуемого буфера.

Требования

Требование	Значение
Минимальная версия клиента	Windows Vista [только классические приложения]
Минимальная версия сервера	Windows Server 2008 [только классические приложения]
Целевая платформа	Windows
Header	wmcodecdsp.h
DLL	Wmvdspa.dll

См. также раздел

IToc

Поделиться через