Função GlobalAddAtomA (winbase.h)

Artigo
08/27/2023

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

Sintaxe

ATOM GlobalAddAtomA(
  [in] LPCSTR 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. Cadeias de caracteres que diferem apenas caso sejam consideradas idênticas. O caso da primeira cadeia de caracteres desse nome adicionado à tabela é preservado e retornado pela função GlobalGetAtomName .

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

Valor retornado

Tipo: ATOM

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

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

Comentários

Se a cadeia de caracteres já existir na tabela atom global, o átomo da cadeia de caracteres existente será retornado e a contagem de referência do átomo será incrementada.

A cadeia de caracteres associada ao atom não é excluída da memória até que sua contagem de referência seja zero. Para obter mais informações, consulte a função GlobalDeleteAtom .

Os atoms globais não são excluídos automaticamente quando o aplicativo é encerrado. Para cada chamada para a função GlobalAddAtom , deve haver uma chamada correspondente para a função GlobalDeleteAtom .

Se o parâmetro lpString tiver o formato "#1234", GlobalAddAtom 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, GlobalAddAtom retornará um atom de cadeia de caracteres.

Observação

O cabeçalho winbase.h define GlobalAddAtom 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


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 (incluir Windows.h)
Biblioteca	Kernel32.lib
DLL	Kernel32.dll