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

Метод GetDescriptionData получает блок данных описания, который ранее был связан с записью путем вызова Метода SetDescriptionData.

Синтаксис

HRESULT GetDescriptionData(
  [in, out] DWORD *pdwDescriptionDataSize,
  [out]     BYTE  *pbtDescriptionData,
  [out]     GUID  *pGuidType
);

Параметры

[in, out] pdwDescriptionDataSize

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

[out] pbtDescriptionData

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

[out] pGuidType

Указатель на переменную, получающую глобальный уникальный идентификатор (GUID), определяющий тип данных в блоке данных описания. См. заметки.

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

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

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

Комментарии

Вы можете связать только один блок данных описания с заданной записью в данный момент времени. Однако может потребоваться разработать различные типы блоков данных описания и определить каждый тип блока с помощью глобально уникального идентификатора (GUID). Таким образом, при вызове SetDescriptionData можно пометить блок данных как определенный тип. При вызове GetDescriptionData можно определить тип полученного блока данных, проверив значение, возвращаемое в pGuidType.

Требования

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

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

ITocEntry

SetDescriptionData