GetStateTextA, fonction (oleacc.h)

Article
11/20/2024

Récupère une chaîne localisée qui décrit l’état d’un objet pour un seul indicateur de bits d’état prédéfini. Étant donné que les valeurs d’état sont une combinaison d’un ou plusieurs indicateurs de bits, les clients appellent cette fonction plusieurs fois pour récupérer toutes les chaînes d’état.

Syntaxe

UINT GetStateTextA(
  [in]  DWORD lStateBit,
  [out] LPSTR lpszState,
  [in]  UINT  cchState
);

Paramètres

[in] lStateBit

Type : DWORD

Une des constantes d’état de l’objet .

[out] lpszState

Type : LPTSTR

Adresse d’une mémoire tampon qui reçoit la chaîne de texte d’état. Si ce paramètre est NULL, la fonction retourne la longueur de la chaîne d’état, sans inclure le caractère Null.

[in] cchState

Type : UINT

Taille de la mémoire tampon pointée par le paramètre lpszStateBit. Pour les chaînes ANSI, cette valeur est mesurée en octets ; pour les chaînes Unicode, elle est mesurée en caractères.

Valeur de retour

Type : UINT

Si elle réussit et si lpszStateBit n’est pasNULL, la valeur de retour correspond au nombre d’octets (chaînes ANSI) ou de caractères (chaînes Unicode) copiés dans la mémoire tampon, sans inclure le caractère de fin null. Si lpszStateBit est NULL, la valeur de retour représente la longueur de la chaîne, sans inclure le caractère Null.

Si la ressource de chaîne n’existe pas ou si le paramètre lpszStateBit n’est pas un pointeur valide, la valeur de retour est zéro (0). Pour obtenir des informations d’erreur étendues, appelez GetLastError.

Remarques

Cette fonction accepte un seul bit d’état à la fois, pas un masque de bits.

Note

L’en-tête oleacc.h définit GetStateText comme 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.

Exigences

Exigence	Valeur
client minimum pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
serveur minimum pris en charge	Windows Server 2003 [applications de bureau uniquement]
plateforme cible	Windows
d’en-tête	oleacc.h
bibliothèque	Oleacc.lib
DLL	Oleacc.dll
redistribuable	Active Accessibility 1.3 RDK sur Windows NT 4.0 avec SP6 et versions ultérieures et Windows 95

Partager via