Método IMFAttributes::GetAllocatedString (mfobjects.h)

  • Artigo

Obtém uma cadeia de caracteres largos associada a uma chave. Esse método aloca a memória para a cadeia de caracteres.

Sintaxe

HRESULT GetAllocatedString(
  [in]  REFGUID guidKey,
  [out] LPWSTR  *ppwszValue,
  [out] UINT32  *pcchLength
);

Parâmetros

[in] guidKey

Um GUID que identifica qual valor recuperar. O tipo de atributo deve ser MF_ATTRIBUTE_STRING.

[out] ppwszValue

Se a chave for encontrada e o valor for um tipo de cadeia de caracteres, esse parâmetro receberá uma cópia da cadeia de caracteres. O chamador deve liberar a memória para a cadeia de caracteres chamando CoTaskMemFree.

[out] pcchLength

Recebe o número de caracteres na cadeia de caracteres, excluindo o caractere NULL de terminação. Esse parâmetro não deve ser NULL.

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
S_OK
 O método foi bem-sucedido.
MF_E_ATTRIBUTENOTFOUND
 A chave especificada não foi encontrada.
MF_E_INVALIDTYPE
 O valor do atributo não é uma cadeia de caracteres.

Comentários

Para copiar um valor de cadeia de caracteres em um buffer alocado pelo chamador, use o método IMFAttributes::GetString .

Essa interface estará disponível nas seguintes plataformas se os componentes redistribuíveis do SDK do Windows Media Format 11 estiverem instalados:

  • Windows XP com Service Pack 2 (SP2) e posterior.
  • Windows XP Media Center Edition 2005 com KB900325 (Windows XP Media Center Edition 2005) e KB925766 (pacote cumulativo de atualizações de outubro de 2006 para Windows XP Media Center Edition) instalados.
Nota Uma versão anterior da documentação afirmou incorretamente que o parâmetro pcchLength pode ser NULL. Definir esse parâmetro como NULL pode ter êxito em alguns casos, mas não é garantido. O chamador deve passar um ponteiro não NULL para esse parâmetro.
 

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows Vista [aplicativos da área de trabalho | Aplicativos UWP]
Servidor mínimo com suporte Windows Server 2008 [aplicativos da área de trabalho | Aplicativos UWP]
Plataforma de Destino Windows
Cabeçalho mfobjects.h (include Mfidl.h)
Biblioteca Mfuuid.lib

Confira também

Atributos e propriedades

IMFAttributes

MF_ATTRIBUTE_TYPE