Método IToc::GetDescription (wmcodecdsp.h)
O método GetDescription recupera a descrição, definida por uma chamada anterior para SetDescription, do sumário.
Sintaxe
HRESULT GetDescription(
[in, out] WORD *pwDescriptionSize,
[out] LPWSTR pwszDescription
);
Parâmetros
[in, out] pwDescriptionSize
Se pwszDescription for NULL, esse será um parâmetro de saída que recebe o tamanho, em caracteres largos, do buffer necessário para receber a descrição. Se pwszDescription não for NULL, esse será um parâmetro de entrada que especifica o tamanho, em caracteres largos, do buffer alocado pelo chamador apontado por pwszDescription.
[out] pwszDescription
NULL ou um ponteiro para um buffer alocado pelo chamador que, após a conclusão bem-sucedida, recebe a descrição. A descrição é terminada em nulo.
Retornar valor
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 |
|---|---|
|
O método foi bem-sucedido. |
|
O método retornará esse código de erro se pwszDescription não for NULL e a descrição, incluindo seu terminador NULL, for maior que o tamanho especificado por pwDescriptionSize. Nesse caso, pwDescriptionSize serve como um parâmetro de saída e recebe o tamanho do buffer necessário. |
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 |