GetTimeFormatWrapW fonction)

[GetTimeFormatWrapW peut être utilisé dans Windows XP. Elle n’est peut-être pas disponible dans les versions ultérieures. Vous devez utiliser GetTimeFormatW à la place.]

Met en forme l’heure sous la forme d’une chaîne d’heure pour les paramètres régionaux spécifiés. La fonction met en forme une heure spécifiée ou l’heure système locale.

Notes

GetTimeFormatWrapW est un wrapper pour la fonction GetTimeFormatW . Pour plus d’informations sur les remarques d’utilisation, consultez la page getTimeFormat .

Syntaxe

int GetTimeFormatWrapW(
  _In_        LCID       Locale,
  _In_        DWORD      dwFlags,
  _In_  const SYSTEMTIME *lpTime,
  _In_        LPCWSTR    pwzFormat,
  _Out_       LPWSTR     pwzTimeStr,
  _In_        int        cchTime
);

Paramètres

Paramètres régionaux [ dans]

Type : LCID

Spécifie les paramètres régionaux pour lesquels la chaîne d’heure doit être mise en forme. Si pwzFormat a la valeur null, la fonction met en forme la chaîne en fonction du format d’heure de ces paramètres régionaux. Si pwzFormat n’a pas la valeur null, la fonction utilise les paramètres régionaux uniquement pour les informations non spécifiées dans la chaîne de format d’image (par exemple, les marqueurs d’heure de la région).

Ce paramètre peut être un identificateur de paramètres régionaux créé par la macro MAKELCID , ou l’une des valeurs prédéfinies suivantes.

paramètres régionaux _ _ par défaut du système

Paramètres régionaux par défaut du système.

paramètres régionaux _ par défaut de l’utilisateur _

Paramètres régionaux utilisateur par défaut.

dwFlags [ dans]

Type : DWORD

Spécifie différentes options de fonction. Vous pouvez spécifier une combinaison des valeurs suivantes.

paramètres régionaux _ NOUSEROVERRIDE

Si cette option est définie, la fonction met en forme la chaîne en utilisant le format d’heure par défaut du système pour les paramètres régionaux spécifiés. S’il n’est pas défini, la fonction met en forme la chaîne à l’aide de n’importe quel remplacement de l’utilisateur au format d’heure par défaut de la région. Cet indicateur ne peut être défini que si pwzFormat a la valeur null.

paramètres régionaux _ use _ CP _ ACP

Utilise la page de codes système ANSI pour la conversion de chaînes à la place de la page de codes des paramètres régionaux.

TEMPS _ NOMINUTESORSECONDS

N’utilise pas de minutes ou de secondes.

intervalle de temps (en _ secondes)

N’utilise pas de secondes.

TEMPS _ NOTIMEMARKER

N’utilise pas de marqueur d’heure.

TEMPS _ FORCE24HOURFORMAT

Utilise toujours un format horaire de 24 heures.

lpTime [ dans]

Type : *const SystemTime * _

Pointeur vers une structure _ SystemTime * qui contient les informations d’heure à mettre en forme. Si ce pointeur est null, la fonction utilise l’heure système locale actuelle.

pwzFormat [ dans]

Type : LPCWSTR

Pointeur vers un format à utiliser pour former la chaîne d’heure. Si pwzFormat a la valeur null, la fonction utilise le format d’heure des paramètres régionaux spécifiés. Pour plus d’informations, consultez getTimeFormat .

pwzTimeStr [ à]

Type : LPWStr

Pointeur vers une mémoire tampon qui reçoit la chaîne d’heure mise en forme.

cchTime [ dans]

Type : int

Taille, en caractères, de la mémoire tampon pwzTimeStr . Si cchTime est égal à zéro, la fonction retourne le nombre de caractères requis pour contenir la chaîne de temps mise en forme, et la mémoire tampon vers laquelle pointe pwzTimeStr n’est pas utilisée.

Valeur retournée

Type : int

Si la fonction a abouti, la valeur de retour est le nombre de caractères écrits dans la mémoire tampon vers laquelle pointe pwzTimeStr. Si le paramètre cchTime est égal à zéro, la valeur de retour est le nombre de caractères requis pour contenir la chaîne de temps mise en forme. Le nombre comprend le caractère null de fin.

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

ERREUR _ de _ mémoire tampon insuffisante

indicateurs d’erreur _ non valide _

paramètre d’erreur _ non valide _

Notes

GetTimeFormatWrapW offre la possibilité d’utiliser des chaînes Unicode dans des systèmes d’exploitation antérieurs à Windows XP. La méthode recommandée consiste à utiliser GetTimeFormatW conjointement avec la couche Microsoft pour Unicode (MSLU).

GetTimeFormatWrapW doit être appelé directement à partir de Shlwapi.dll, à l’aide de l’ordinal 310.

Spécifications

Condition requise Valeur
Client minimal pris en charge
Windows 2000 professionnel, applications de [ Bureau Windows XP uniquement]
Serveur minimal pris en charge
Applications de bureau Windows Server 2003 [ uniquement]
DLL
Shlwapi.dll (version 5,0 ou ultérieure)

Voir aussi

GetTimeFormat