Date de parution : 21/07/2003
- Cette fiche API a été lue 1656 fois
Description
GetDateFormat formate une date comme une chaîne date pour une spécification locale. Le formatage se fait pour un date spécifié ou par une date système locale. Si la fonction réussit, la valeur de retour est le nombre d'octets (version ANSI) ou de caractères (version Unicode) écrit dans le tampon lpDateStr, ou si le paramètre cchDate est à zéro, le nombre recquis pour formater la chaîne date. Si la fonction faillit, la valeur de retour est à zéro. Pour obtenir un message d'erreur étendu, appeler GetLastError qui peut retourner un des codes erreur suivant :
Ce paramètre peut être un identifiant local ou une des valeurs prédéfinies suivante :
LOCALE_SYSTEM_DEFAULT
Date système locale par défaut.
LOCALE_USER_DEFAULT
Date utilisateur locale par défaut
dwFlags
Un jeu de sémaphores bit qui spécifie les options de fonction variable. Si lpForat est non Null, ce paramètre doit être à zéro sinon une combinaison des sémaphores suivants :
Sémaphore
Signification
LOCALE_NOUSEROVERRIDE = 2147483648
Si mis, la fonction formate la chaîne utilisant la date système par défaut à la place du locale. Si non mis, la fonction formate la chaîne utilisant la date locale par défaut.
DATE_SHORTDATE = 1
Format de date court. Ne peut être utilisé avec DATE_LONGDATE.
DATE_LONGDATE = 2
Format de date long. Ne peut être utilisé avec DATE_SHORTDATE.
DATE_USE_ALT_CALENDAR
Utilise un calendrier alternatif, s'il en existe un, pour formater la chaîne date.
lpDate
Pointe sur une structure SYSTEMTIME qui contient l'information date à formater.
lpFormat
Pointe vers une image de formatage de la chaîne à utiliser pour former la chaîne date.
Image
Signification
d
Jour du mois sans zéro non significatif.
dd
Jour du mois avec zéro non significatif.
ddd
Jour de la semaine en abrégé sur trois lettres.
dddd
Jour de la semaine en entier.
M
Mois en chiffre sans zéro non significatif.
MM
Mois en chiffre avec zéro non significatif.
MMM
Mois abrégé sur trois lettres.
MMMM
Mois en entier.
y
Année sur les deux derniers chiffres mais sans zéro non significatif.
yy
Année sur les deux derniers chiffres mais avec zéro non significatif.
yyyy
Année sur quatre chiffres.
gg
La fonction utilise la valeur CAL_SERASTRING associée avec la chaîne locale spécifiée.
lpDateStr
Pointe sur un tampon qui reçoit la chaîne date formatée.
cchDate
Précise la taille de la chaîne lpDateStr. Si cchDate est à zéro, la fonction retourne le nombre d'octets ou de caractères requis pour tenir le formatage de la chaîne date et lpDateStr n'est pas utilisé.
Compatibilité
Windows 95 :
supporté.
Windows 98 :
supporté.
Windows NT :
réclame Windows NT 3.1 ou plus.
Windows 2000 :
supporté.
Windows CE :
réclame Windows CE 1.0 ou plus.
Remarque
Aucune
Exemple 1
// Afficher la date au format de l'Internet HTTP
st
est un SYSTEMTIME
lpFormat est une chaîne asciiz sur 255
lpDateStr est une chaîne asciiz sur 255
cchDate est un entier
AppelDLL32
("kernel32","GetLocalTime", &st)
// Du code offert par Beaussier en ligne ! pour le Centre W..D..
lpFormat = "ddd dd MMM yyyy"
cchDate = Dimension(lpDateStr)
AppelDLL32("kernel32","GetDateFormatA", 0, 0, &st, &lpFormat, &lpDateStr, cchDate)
Info("Nous sommes le : " + lpDateStr)