Liste des fonctions

Create

BOOL Create(
  DWORD ThreadNotifyId,
  HINSTANCE hInstance,
  HWND hParent,
  int XChar,
  int YChar,
  char *lpFont,
  int FontSize
);
  
Crée une console.

Paramètres

ThreadNotifyId

L'identifiant du thread qui recevra les messages de notification. Ce paramètre ne peut pas être NULL.

hInstance

HANDLE de l'instance de l'application qui crée la console. Ce HANDLE est passé à la fonction WinMain().

hParent

HANDLE de la fenêtre parent. Si ce HANDLE est NULL la fenêtre sera créée en tant que fenêtre parent. Sinon, la fenêtre sera déclarée comme enfant.

XChar

Largeur en nombre de caractères de la console.

YChar

Hauteur en nombre de caractères de la console.

lpFont

Une chaîne de caractère contenant le nom de la police utilisée. Cette police doit être une police à espacement fixe pour un bon fonctionnement. Si ce paramètre est NULL, la police par défaut sera utilisée.

FontSize

Taille de la police. La taille doit être compise entre 4 et 100. Si une taille invalide est spécifiée, la taille par défaut (10) sera utilisée.

Valeur retournée

TRUE si la console est effectivement créée. FALSE autrement.

Show

BOOL Show(
  int nCmdShow
);
  
Affiche la console.

Paramètres

nCmdShow

Indique comment la fenêtre sera affichée. Ce paramètre peut prendre les même valeurs que pour la fonction ShowWindow.

Valeur retournée

TRUE en cas de succès, FALSE autrement.

Show

BOOL Show(
  void
);
  
Affiche la console.

Valeur retournée

TRUE en cas de succès, FALSE autrement.

Redraw

BOOL Redraw(
  void
);
  
Rafraichit la console.

Valeur retournée

TRUE en cas de succès, FALSE autrement.

ScrollDown

BOOL ScrollDown(
  void
);
  
Fait défiler la console d'une ligne.

Valeur retournée

TRUE en cas de succès, FALSE autrement.

TextOut

BOOL TextOut(
  char* Text,
  int len
);
  
Affiche un texte dans la console.

Paramètres

Text

Un pointeur sur le texte à afficher.

len

Longueur à afficher. Si cette longueur est -1, la fonction strlen() est appelée pour tenter de déterminer la longueur de la chaîne.

Valeur retournée

TRUE en cas de succès, FALSE autrement.

SetTextAtribute

BOOL SetTextAtribute(
  COLORREF TextCol,
  COLORREF BgCol
);
  
Modifie les attributs du pointeur de texte courant. Les appels à la fonction TextOut() utilisent ces paramètres pour afficher le texte.

Paramètres

TextCol

Couleur du texte.

BgCol

Couleur du fond

Valeur retournée

TRUE en cas de succès, FALSE autrement.

SetCursorSpeed

BOOL SetCursorSpeed(
  DWORD Int
);
  
Modifie la vitesse de clignotement du curseur.

Paramètres

SetCursorSpeed

Vitesse de clignotement en ms. Les valeurs doivent être comprises entre 100 et 5000.

Valeur retournée

TRUE en cas de succès, FALSE autrement.

SetCursorChar

BOOL SetCursorChar(
  char NewChar
);
  
Modifie le caractère utilisé comme curseur.

Paramètres

NewChar

Caractère à utiliser. Le caractère par défaut est '_'.

Valeur retournée

TRUE en cas de succès, FALSE autrement.

GetHandle

HWND GetHandle(
  void
);
  
Retourn un HANDLE (de type HWND) sur la fenêtre de la console.

Valeur retournée

Un HWND si la console est créée. NULL autrement.

Free

BOOL Free(
  void
);
  
Vide totalement la console. La position du curseur n'est pas modifiée.

Valeur retournée

TRUE en cas de succès, FALSE autrement.

getch

int getch(
  void
);
  
Récupère un caractère sans écho.

Valeur retournée

Retourne le code ASCII du caractère entré.

getche

int getche(
  void
);
  
Récupère un carctère avec écho.

Valeur retournée

Retourne le code ASCII du caractère entré.

SetCursorPos

BOOL SetCursorPos(
  POINT NewPos
);
  
Modifie la position du curseur.

Paramètres

NewPos

Nouvelle position.

Valeur retournée

TRUE en cas de succès, FALSE autrement.

GetCursorPos

BOOL GetCursorPos(
  LPPOINT CurrentPos
);
  
Retourne la position courante du curseur.

Paramètres

CurrentPos

Un pointeur pour recevoir la position courante du pointeur.

Valeur retournée

TRUE en cas de succès, FALSE autrement.

SetTitle

BOOL SetTitle(
  char *pbuf
);
  
Modifie le texte de la barre de titre de la console.

Paramètres

pbuf

Pointeur sur le texte.

Valeur retournée

TRUE en cas de succès, FALSE autrement.

GetTitle

BOOL GetTitle(
  char *pbuf,
  int max
);
  
Permet de récupérer le texte de la barre de titre de la console.

Paramètres

pbuf

Pointeur qui recevra le texte.

max

Taille maximale à retourner. Si la texte de la barre de titre est supérieur à cette valeur la fonction échouera.

Valeur retournée

TRUE en cas de succès, FALSE autrement.

Input

BOOL Input(
  char *pbuf,
  int max
);
  
Récupère une chaîne de caractères entrée par l'utilisateur.

Paramètres

pbuf

Pointeur qui contiendra la chaîne de caractère entrée.

max

Longueur maximale de la chaîne qui pourra être entrée.

Valeur retournée

Cette fonction retourne toujours TRUE sauf si max<=1 ou si la console n'est pas initialisée.

Destroy

BOOL Destroy(
  void
);
  
Détruit la console.

Valeur retournée

TRUE en cas de succès, FALSE autrement.

SetIcon - SetIconSm

BOOL SetIcon(
  HICON hNewIcon,
  VOID *hOldIcon
);

BOOL SetIconSm(
  HICON hNewIcon,
  VOID *hOldIcon
);
  
Ces fonctions modifient les icône de la fenêtre de console. Les icônes modifiées sont celles qui apparaissent lors d'une pression de ALT+TAB et dans le menu système ou la barre des tâches.

Paramètres

hNewIcon

Nouvelle icône.

hOldIcon

Pointeur sur l'ancienne icône.

Valeur retournée

TRUE en cas de succès, FALSE autrement.

GetPixelSize

BOOL GetPixelSize(
  SIZE *lpSize
);
  
Retourne la taille en pixels de la console.

Paramètres

lpSize

Un pointeur qui recevra la taille de la console.

Valeur retournée

TRUE en cas de succès, FALSE autrement.

lpSize

BOOL GetCharSize(
  SIZE *lpSize
);
  
Retourne la taille en caractères de la console.

Paramètres

lpSize

Pointeur qui recevra la taille de la console.

Valeur retournée

TRUE en cas de succès, FALSE autrement.

GetBuffer

BOOL GetBuffer(
  CO_CHAR *lpData,
  DWORD *lpSize
);
  
Retourne le buffer de la console.

Paramètres

lpData

Un pointeur sur un tableau de type CO_CHAR qui recevra l'ensemble des caractères de la console actuelle.

lpSize

Un pointeur qui recevra la taille en octets du buffer copié. La taille est calculée de la manière suivante : CharSize.cx*CharSize.cy*sizeof(CO_CHAR). Ou CharSize est une structure de type SIZE contenant la taille en caractères de la console.

Valeur retournée

TRUE en cas de succès, FALSE autrement.