Compartilhar via


Função WindowsCreateString (winstring.h)

Cria um novo HSTRING com base na cadeia de caracteres de origem especificada.

Sintaxe

HRESULT WindowsCreateString(
  PCNZWCH sourceString,
  UINT32  length,
  HSTRING *string
);

Parâmetros

sourceString

Tipo: [in, opcional] LPCWSTR

O buffer de texto codificado em UTF-16LE a ser usado como a origem do novo HSTRING. Para criar uma cadeia de caracteres nova, vazia ou NULL , passe NULL para sourceString e 0 para o comprimento.

Esse buffer não é necessário para ser encerrado em nulo. O WindowsCreateString copiará seu conteúdo e adicionará um terminador nulo no novo buffer que faz backup do HSTRING retornado.

length

Tipo: [in] UINT32

O comprimento de sourceString, em caracteres Unicode. Deve ser 0 se sourceString for NULL.

string

Tipo: [out] HSTRING*

Um ponteiro para o HSTRING recém-criado ou NULL se ocorrer um erro. Qualquer conteúdo existente na cadeia de caracteres é substituído. O HSTRING é um tipo de identificador padrão.

Valor de retorno

Tipo: HRESULT

Essa função pode retornar um desses valores.

Código de retorno Description
S_OK
O HSTRING foi criado com êxito.
E_INVALIDARG
cadeia de caracteres é NULL.
E_OUTOFMEMORY
Falha ao alocar o novo HSTRING.
E_POINTER
sourceString é NULL e o comprimento não é zero.

Observações

Use a função WindowsCreateString para alocar um novo HSTRING. O Windows Runtime copia a cadeia de caracteres para o buffer de backup do novo HSTRING e gerencia o tempo de vida do buffer usando uma contagem de referência. Chame a função WindowsCreateStringReference para criar uma cadeia de caracteres de passagem rápida, que usa uma cadeia de caracteres existente sem copiá-la.

Chame a função WindowsDeleteString para desalocar o HSTRING. Cada chamada para a função WindowsCreateString deve ser correspondida por uma chamada para WindowsDeleteString.

Para criar uma cadeia de caracteres nova, vazia ou NULL , passe NULL para sourceString e 0 para o comprimento.

Se sourceString tiver caracteres nulos inseridos, a função WindowsCreateString copiará todos os caracteres para o caractere nulo de encerramento.

Requirements

Requirement Value
Cliente mínimo suportado Windows 8 [aplicativos da área de trabalho | Aplicativos UWP]
Servidor mínimo compatível Windows Server 2012 [aplicativos da área de trabalho | Aplicativos UWP]
da Plataforma de Destino Windows
Header winstring.h
Library mincore.lib

Consulte também

WindowsCreateStringReference

WindowsDeleteString