Fonction DdeQueryStringA (ddeml.h)

Article
08/23/2023

Copie le texte associé à un handle de chaîne dans une mémoire tampon.

Syntaxe

DWORD DdeQueryStringA(
  [in]            DWORD idInst,
  [in]            HSZ   hsz,
  [out, optional] LPSTR psz,
  [in]            DWORD cchMax,
  [in]            int   iCodePage
);

Paramètres

[in] idInst

Type : DWORD

L’application instance identificateur obtenu par un appel précédent à la fonction DdeInitialize.

[in] hsz

Type : HSZ

Handle de la chaîne à copier. Ce handle doit avoir été créé par un appel précédent à la fonction DdeCreateStringHandle .

[out, optional] psz

Type : LPTSTR

Pointeur vers une mémoire tampon qui reçoit la chaîne. Pour obtenir la longueur de la chaîne, ce paramètre doit avoir la valeur NULL.

[in] cchMax

Type : DWORD

Longueur, en caractères, de la mémoire tampon pointée vers le paramètre psz . Pour la version ANSI de la fonction, il s’agit du nombre d’octets ; pour la version Unicode, il s’agit du nombre de caractères. Si la chaîne est plus longue que ( cchMax– 1), elle est tronquée. Si le paramètre psz a la valeur NULL, ce paramètre est ignoré.

[in] iCodePage

Type : int

Page de code utilisée pour restituer la chaîne. Cette valeur doit être CP_WINANSI ou CP_WINUNICODE.

Valeur retournée

Type : DWORD

Si le paramètre psz a spécifié un pointeur valide, la valeur renvoyée est la longueur, en caractères, du texte retourné (sans le caractère null de fin). Si le paramètre psz a spécifié un pointeur NULL , la valeur renvoyée est la longueur du texte associé au paramètre hsz (sans le caractère null de fin). Si une erreur se produit, la valeur de retour est 0L.

Remarques

La chaîne retournée dans la mémoire tampon est toujours terminée par null. Si la chaîne est plus longue que ( cchMax– 1), seuls les premiers caractères ( cchMax– 1) de la chaîne sont copiés.

Si le paramètre psz a la valeur NULL, la fonction DdeQueryString obtient la longueur, en octets, de la chaîne associée au handle de chaîne. La longueur n’inclut pas le caractère null de fin.

Notes

L’en-tête ddeml.h définit DdeQueryString 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	ddeml.h (inclure Windows.h)
Bibliothèque	User32.lib
DLL	User32.dll