GetClipboardFormatNameA, fonction (winuser.h)

  • Article

Récupère dans le Presse-papiers le nom du format inscrit spécifié. La fonction copie le nom dans la mémoire tampon spécifiée.

Syntaxe

int GetClipboardFormatNameA(
  [in]  UINT  format,
  [out] LPSTR lpszFormatName,
  [in]  int   cchMaxCount
);

Paramètres

[in] format

Type : UINT

Type de format à récupérer. Ce paramètre ne doit spécifier aucun des formats prédéfinis du Presse-papiers.

[out] lpszFormatName

Type : LPTSTR

Mémoire tampon qui doit recevoir le nom de format.

[in] cchMaxCount

Type : int

Longueur maximale, en caractères, de la chaîne à copier dans la mémoire tampon. Si le nom dépasse cette limite, il est tronqué.

Valeur retournée

Type : int

Si la fonction réussit, la valeur de retour est la longueur, en caractères, de la chaîne copiée dans la mémoire tampon.

Si la fonction échoue, la valeur de retour est zéro, ce qui indique que le format demandé n’existe pas ou est prédéfini. Pour obtenir des informations détaillées sur l’erreur, appelez GetLastError.

Remarques

Considérations relatives à la sécurité

L’utilisation incorrecte de cette fonction peut compromettre la sécurité de votre programme. Par exemple, le calcul incorrect de la taille appropriée de la mémoire tampon lpszFormatName , en particulier lorsque l’application est utilisée dans les versions ANSI et Unicode, peut entraîner un dépassement de mémoire tampon. Notez également que la chaîne est tronquée si elle est plus longue que le paramètre cchMaxCount , ce qui peut entraîner une perte d’informations.

Exemples

Pour obtenir un exemple, consultez Exemple de visionneuse du Presse-papiers.

Notes

L’en-tête winuser.h définit GetClipboardFormatName 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 winuser.h (inclure Windows.h)
Bibliothèque User32.lib
DLL User32.dll
Ensemble d’API ext-ms-win-ntuser-misc-l1-1-0 (introduit dans Windows 8)

Voir aussi

Presse-papiers

Conceptuel

EnumClipboardFormats

Référence

RegisterClipboardFormat