Método IToc::GetDescription (wmcodecdsp.h)

El método GetDescription recupera la descripción, establecida por una llamada anterior a SetDescription, de la tabla de contenido.

Sintaxis

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

Parámetros

[in, out] pwDescriptionSize

Si pwszDescription es NULL, se trata de un parámetro de salida que recibe el tamaño, en caracteres anchos, del búfer necesario para recibir la descripción. Si pwszDescription no es NULL, se trata de un parámetro de entrada que especifica el tamaño, en caracteres anchos, del búfer asignado por el autor de la llamada al que apunta pwszDescription.

[out] pwszDescription

NULL, o un puntero a un búfer asignado por el autor de la llamada que, al finalizar correctamente, recibe la descripción. La descripción está terminada en null.

Valor devuelto

El método devuelve un valor HRESULT. Entre los valores posibles se incluyen los que se indican en la tabla siguiente, entre otros.

Código devuelto	Descripción
S_OK	El método se ha llevado a cabo de forma correcta.
MF_E_BUFFERTOOSMALL	El método devuelve este código de error si pwszDescription no es NULL y la descripción, incluido su terminador NULL , es mayor que el tamaño especificado por pwDescriptionSize. En ese caso, pwDescriptionSize actúa como parámetro de salida y recibe el tamaño del búfer necesario.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows Vista [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2008 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	wmcodecdsp.h
Archivo DLL	Wmvdspa.dll

Consulte también

IToc