Fonction EnumClipboardFormats (winuser.h)

Article
03/04/2024

Énumère les formats de données actuellement disponibles dans le Presse-papiers.

Les formats de données du Presse-papiers sont stockés dans une liste triée. Pour effectuer une énumération des formats de données du Presse-papiers, vous effectuez une série d’appels à la fonction EnumClipboardFormats . Pour chaque appel, le paramètre de format spécifie un format de Presse-papiers disponible, et la fonction retourne le format de Presse-papiers suivant disponible.

Syntaxe

UINT EnumClipboardFormats(
  [in] UINT format
);

Paramètres

[in] format

Type : UINT

Format du Presse-papiers connu pour être disponible.

Pour démarrer une énumération des formats du Presse-papiers, définissez format sur zéro. Lorsque le format est égal à zéro, la fonction récupère le premier format du Presse-papiers disponible. Pour les appels suivants au cours d’une énumération, définissez le format sur le résultat de l’appel EnumClipboardFormats précédent.

Valeur retournée

Type : UINT

Si la fonction réussit, la valeur de retour est le format du Presse-papiers qui suit le format spécifié, à savoir le prochain format disponible du Presse-papiers.

Si la fonction échoue, la valeur de retour est égale à zéro. Pour obtenir des informations détaillées sur l’erreur, appelez GetLastError. Si le Presse-papiers n’est pas ouvert, la fonction échoue.

S’il n’y a plus de formats de Presse-papiers à énumérer, la valeur de retour est zéro. Dans ce cas, la fonction GetLastError retourne la valeur ERROR_SUCCESS. Cela vous permet de faire la distinction entre l’échec de la fonction et la fin de l’énumération.

Remarques

Vous devez ouvrir le Presse-papiers avant d’énumérer ses formats. Utilisez la fonction OpenClipboard pour ouvrir le Presse-papiers. La fonction EnumClipboardFormats échoue si le Presse-papiers n’est pas ouvert.

La fonction EnumClipboardFormats énumère les formats dans l’ordre dans lequel ils ont été placés dans le Presse-papiers. Si vous copiez des informations dans le Presse-papiers, ajoutez des objets de Presse-papiers dans l’ordre, du format de Presse-papiers le plus descriptif au format de Presse-papiers le moins descriptif. Si vous collez des informations à partir du Presse-papiers, récupérez le premier format du Presse-papiers que vous pouvez gérer. Il s’agira du format de Presse-papiers le plus descriptif que vous pouvez gérer.

Le système fournit des conversions de type automatiques pour certains formats du Presse-papiers. Dans le cas d’un tel format, cette fonction énumère le format spécifié, puis énumère les formats vers lesquels elle peut être convertie. Pour plus d’informations, consultez Formats du Presse-papiers standard et Formats du Presse-papiers synthétisé.

Exemples

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

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-5-1 (introduit dans Windows 10, version 10.0.14393)