Compartilhar via


Método ITocEntry::GetDescriptionData (wmcodecdsp.h)

O método GetDescriptionData obtém um bloco de dados de descrição que foi anteriormente associado à entrada por uma chamada para SetDescriptionData.

Sintaxe

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

Parâmetros

[in, out] pdwDescriptionDataSize

Se pbtDescriptionData for NULL, esse será um parâmetro de saída que recebe o tamanho, em bytes, do bloco de dados de descrição. Se pbtDescriptionData não for NULL, este será um parâmetro de entrada que especifica o tamanho, em bytes, do buffer alocado pelo chamador apontado por pbtDescriptionData.

[out] pbtDescriptionData

NULL ou um ponteiro para um buffer alocado pelo chamador que, após a conclusão bem-sucedida, recebe o bloco de dados de descrição.

[out] pGuidType

Ponteiro para uma variável que recebe um GUID (identificador global exclusivo) que identifica o tipo de dados no bloco de dados de descrição. Consulte Observações.

Valor retornado

O método retorna um HRESULT. Os possíveis valores incluem, mas sem limitação, aqueles na tabela a seguir.

Código de retorno Descrição
S_OK
O método foi bem-sucedido.
MF_E_BUFFERTOOSMALL
O método retornará esse código de erro se pbtDescriptionData não for NULL e o bloco de contexto for maior que o tamanho especificado por pdwDescriptionDataSize. Nesse caso, pdwDescriptionDataSize serve como um parâmetro de saída e recebe o tamanho, em bytes, do buffer necessário.

Comentários

Você pode associar apenas um bloco de dados de descrição a uma determinada entrada em um determinado momento. No entanto, talvez você queira criar diferentes tipos de blocos de dados de descrição e identificar cada tipo de bloco com um GUID (identificador global exclusivo). Dessa forma, ao chamar SetDescriptionData, você pode marcar o bloco de dados como sendo de um tipo específico. Ao chamar GetDescriptionData, você pode determinar o tipo do bloco de dados recuperado inspecionando o valor retornado em pGuidType.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows Server 2008 [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho wmcodecdsp.h
DLL Wmvdspa.dll

Confira também

ITocEntry

SetDescriptionData