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.

Spécifications