AddAtomW, fonction (winbase.h)

Article
03/06/2024

Ajoute une chaîne de caractères à la table d’atomes locale et retourne une valeur unique (un atome) identifiant la chaîne.

Syntaxe

ATOM AddAtomW(
  [in] LPCWSTR lpString
);

Paramètres

[in] lpString

Type : LPCTSTR

Chaîne terminée par null à ajouter. La chaîne peut avoir une taille maximale de 255 octets. Les chaînes qui diffèrent uniquement en cas sont considérées comme identiques. Le cas de la première chaîne ajoutée est conservé et retourné par la fonction GetAtomName .

Vous pouvez également utiliser un atome entier qui a été converti à l’aide de la macro MAKEINTATOM . Pour plus d’informations, consultez les remarques.

Valeur retournée

Type : ATOM

Si la fonction réussit, la valeur de retour est l’atome nouvellement créé.

Si la fonction échoue, la valeur de retour est égale à zéro. Pour obtenir des informations détaillées sur l’erreur, appelez GetLastError.

Remarques

La fonction AddAtom ne stocke pas plus d’une copie d’une chaîne donnée dans la table atom. Si la chaîne se trouve déjà dans la table, la fonction retourne l’atome existant et, dans le cas d’un atome de chaîne, incrémente le nombre de références de la chaîne.

Si lpString a la forme « #1234 », AddAtom retourne un atome entier dont la valeur est la représentation 16 bits du nombre décimal spécifié dans la chaîne (0x04D2, dans cet exemple). Si la valeur décimale spécifiée est 0x0000 ou est supérieure ou égale à 0xC000, la valeur de retour est égale à zéro, ce qui indique une erreur. Si lpString a été créé par la macro MAKEINTATOM , le mot d’ordre inférieur doit se trouver dans la plage 0x0001 0xBFFF. Si le mot de bas ordre n’est pas dans cette plage, la fonction échoue.

Si lpString a une autre forme, AddAtom retourne un atome de chaîne.

Notes

L’en-tête winbase.h définit AddAtom comme un alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. Le mélange de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	winbase.h (inclure Windows.h)
Bibliothèque	Kernel32.lib
DLL	Kernel32.dll