GetStateTextA, fonction (oleacc.h)

Récupère une chaîne localisée qui décrit l’état d’un objet pour un seul indicateur de bit d’état prédéfini. Étant donné que les valeurs d’état sont une combinaison d’un ou de 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 a la valeur 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 vers laquelle pointe le paramètre lpszStateBit . Pour les chaînes ANSI, cette valeur est mesurée en octets ; pour les chaînes Unicode, il est mesuré en caractères.

Valeur retournée

Type : UINT

En cas de réussite et si lpszStateBit n’a pas la valeur NULL, 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 compter le caractère terminé par null. Si lpszStateBit a la valeur 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étaillées sur l’erreur, appelez GetLastError.

Notes

Cette fonction n’accepte qu’un seul bit d’état à la fois, et non un masque de bits.

Notes

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

Spécifications

Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2003 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	oleacc.h
Bibliothèque	Oleacc.lib
DLL	Oleacc.dll
Composant redistribuable	Active Accessibility 1.3 RDK sur Windows NT 4.0 avec SP6 et versions ultérieures et Windows 95