Função AddAtomW (winbase.h)

Artigo
03/08/2023

Adiciona uma cadeia de caracteres à tabela atom local e retorna um valor exclusivo (um átomo) que identifica a cadeia de caracteres.

Sintaxe

ATOM AddAtomW(
  [in] LPCWSTR lpString
);

Parâmetros

[in] lpString

Tipo: LPCTSTR

A cadeia de caracteres terminada em nulo a ser adicionada. A cadeia de caracteres pode ter um tamanho máximo de 255 bytes. As cadeias de caracteres que diferem apenas no caso de serem consideradas idênticas. O caso da primeira cadeia de caracteres adicionada é preservado e retornado pela função GetAtomName .

Como alternativa, você pode usar um átomo inteiro que foi convertido usando a macro MAKEINTATOM . Consulte os Comentários para obter mais informações.

Retornar valor

Tipo: ATOM

Se a função for bem-sucedida, o valor retornado será o átomo recém-criado.

Se a função falhar, o valor retornado será zero. Para obter informações de erro estendidas, chame GetLastError.

Comentários

A função AddAtom armazena não mais do que uma cópia de uma determinada cadeia de caracteres na tabela atom. Se a cadeia de caracteres já estiver na tabela, a função retornará o átomo existente e, no caso de um átomo de cadeia de caracteres, incrementará a contagem de referência da cadeia de caracteres.

Se lpString tiver a forma "#1234", AddAtom retornará um átomo inteiro cujo valor é a representação de 16 bits do número decimal especificado na cadeia de caracteres (0x04D2, neste exemplo). Se o valor decimal especificado for 0x0000 ou for maior ou igual a 0xC000, o valor retornado será zero, indicando um erro. Se lpString tiver sido criado pela macro MAKEINTATOM , a palavra de baixa ordem deverá estar no intervalo 0x0001 até 0xBFFF. Se a palavra de baixa ordem não estiver nesse intervalo, a função falhará.

Se lpString tiver qualquer outra forma, AddAtom retornará um átomo de cadeia de caracteres.

Observação

O cabeçalho winbase.h define AddAtom como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante de pré-processador UNICODE. Misturar o uso do alias neutro de codificação com código que não seja neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Convenções para protótipos de função.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	winbase.h (inclua Windows.h)
Biblioteca	Kernel32.lib
DLL	Kernel32.dll