Fonction SetConsoleOutputCP

Article
12/15/2023

Définit la page de codes de sortie utilisée par la console associée au processus appelant. Une console utilise sa page de codes de sortie pour traduire les valeurs de caractères écrites par les différentes fonctions de sortie dans les images affichées dans la fenêtre de console.

Syntaxe

BOOL WINAPI SetConsoleOutputCP(
  _In_ UINT wCodePageID
);

Paramètres

wCodePageID [entrée]
Identificateur de la page de codes à définir. Pour plus d'informations, consultez la section Notes.

Valeur retournée

Si la fonction réussit, la valeur de retour est différente de zéro.

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

Notes

Une page de codes mappe 256 codes de caractères à des caractères individuels. Les différentes pages de code incluent des caractères spéciaux différents, généralement personnalisés pour une langue ou un groupe de langues.

Si la police actuelle est une police Unicode à chasse fixe, SetConsoleOutputCP modifie le mappage des valeurs de caractères dans le jeu de glyphes de la police, plutôt que de charger une police distincte chaque fois qu’elle est appelée. Cela affecte l’affichage des caractères étendus (valeur ASCII supérieure à 127) dans une fenêtre de console. Toutefois, si la police actuelle est une police Raster, SetConsoleOutputCP n’affecte pas la façon dont les caractères étendus sont affichés.

Pour rechercher les pages de code installées ou prises en charge par le système d’exploitation, utilisez la fonction EnumSystemCodePages. Les identificateurs des pages de codes disponibles sur l’ordinateur local sont également stockés dans le registre sous la clé suivante :

HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Nls\CodePage

Toutefois, il est préférable d’utiliser EnumSystemCodePages pour énumérer les pages de codes, car le registre peut différer dans différentes versions de Windows. Pour déterminer si une page de codes particulière est valide, utilisez la fonction IsValidCodePage. Pour récupérer plus d’informations sur une page de codes, y compris son nom, utilisez la fonction GetCPInfoEx. Pour obtenir la liste des identificateurs de page de codes disponibles, consultez Identificateurs de page de codes.

Pour déterminer la page de codes de sortie actuelle d’une console, utilisez la fonction GetConsoleOutputCP. Pour définir et récupérer la page de codes d’entrée d’une console, utilisez les fonctions SetConsoleCP et GetConsoleCP.

Spécifications


Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
En-tête	ConsoleApi2.h (via WinCon.h, inclure Windows.h)
Bibliothèque	Kernel32.lib
DLL	Kernel32.dll