Метод ITocEntry::GetTitle (wmcodecdsp.h)

Статья
08/28/2023

Метод GetTitle извлекает заголовок записи, заданный предыдущим вызовом SetTitle.

Синтаксис

HRESULT GetTitle(
  [in, out] WORD   *pwTitleSize,
  [out]     LPWSTR pwszTitle
);

Параметры

[in, out] pwTitleSize

Если pwszTitle имеет значение NULL, это выходной параметр, который получает размер буфера в широких символах, необходимый для получения заголовка. Если pwszTitle не имеет значение NULL, это входной параметр, указывающий размер буфера, выделенного вызывающим объектом, в широких символах, на который указывает pwszTitle.

[out] pwszTitle

NULL или указатель на буфер, выделенный вызывающим объектом, который при успешном завершении получает заголовок. Заголовок заканчивается null.

Возвращаемое значение

Метод возвращает HRESULT. Допустимые значения включают, но не ограничиваются, значения, приведенные в следующей таблице.

Код возврата	Описание
S_OK	Метод выполнен успешно.
MF_E_BUFFERTOOSMALL	Метод возвращает этот код ошибки, если pwszTitle не имеет значения NULL и заголовок, включая его признак конца NULL, больше размера, заданного pwTitleSize. В этом случае pwTitleSize служит выходным параметром и получает размер требуемого буфера.

Код возврата

Описание

S_OK

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

MF_E_BUFFERTOOSMALL

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

Требования

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

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

ITocEntry

SetTitle

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