Función AddAtomW (winbase.h)

Artículo
03/09/2024

Agrega una cadena de caracteres a la tabla atom local y devuelve un valor único (un átomo) que identifica la cadena.

Sintaxis

ATOM AddAtomW(
  [in] LPCWSTR lpString
);

Parámetros

[in] lpString

Tipo: LPCTSTR

Cadena terminada en null que se va a agregar. La cadena puede tener un tamaño máximo de 255 bytes. Las cadenas difieren solo en caso de que se consideren idénticas. El caso de la primera cadena agregada se conserva y devuelve mediante la función GetAtomName .

Como alternativa, puede usar un átomo entero que se ha convertido mediante la macro MAKEINTATOM . Vea la sección Comentarios para obtener más información.

Valor devuelto

Tipo: ATOM

Si la función se realiza correctamente, el valor devuelto es el átomo recién creado.

Si la función no se realiza correctamente, el valor devuelto es cero. Para obtener información de error extendida, llame a GetLastError.

Comentarios

La función AddAtom no almacena más de una copia de una cadena determinada en la tabla atom. Si la cadena ya está en la tabla, la función devuelve el átomo existente y, en el caso de un átomo de cadena, incrementa el recuento de referencias de la cadena.

Si lpString tiene el formato "#1234", AddAtom devuelve un átomo entero cuyo valor es la representación de 16 bits del número decimal especificado en la cadena (0x04D2, en este ejemplo). Si el valor decimal especificado es 0x0000 o es mayor o igual que 0xC000, el valor devuelto es cero, lo que indica un error. Si lpString se creó mediante la macro MAKEINTATOM , la palabra de orden bajo debe estar en el intervalo 0x0001 a través de 0xBFFF. Si la palabra de orden bajo no está en este intervalo, se produce un error en la función.

Si lpString tiene cualquier otro formato, AddAtom devuelve un átomo de cadena.

Nota

El encabezado winbase.h define AddAtom como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutral de codificación con código que no es neutral de codificación puede dar lugar a errores de coincidencia que dan lugar a errores de compilación o tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	winbase.h (incluye Windows.h)
Library	Kernel32.lib
Archivo DLL	Kernel32.dll