Fonction SHFormatDateTimeA (shlwapi.h)

[SHFormatDateTime est disponible pour une utilisation dans les systèmes d’exploitation spécifiés dans la section Configuration requise. Il peut être modifié ou indisponible dans les versions suivantes.]

Produit une représentation sous forme de chaîne d’une heure spécifiée en tant que structure FILETIME .

Syntaxe

int SHFormatDateTimeA(
  [in]                const FILETIME *pft,
  [in, out, optional] DWORD          *pdwFlags,
  [out]               LPSTR          pszBuf,
                      UINT           cchBuf
);

Paramètres

[in] pft

Type : const FILETIME UNALIGNED*

Pointeur vers la structure FILETIME dont l’heure doit être convertie en chaîne.

[in, out, optional] pdwFlags

Type : DWORD*

Pointeur vers une valeur DWORD qui contient des indicateurs au niveau du bit qui spécifient le format de date et d’heure.

Lorsque vous appelez la fonction, vous pouvez combiner zéro ou plusieurs des indicateurs suivants, avec des exceptions comme indiqué. Vous pouvez également définir ce paramètre sur NULL, auquel cas la fonction suppose que l’indicateur FDTF_DEFAULT est défini.

FDTF_SHORTTIME (0x00000001)

0x00000001. Met en forme l’heure de la journée comme spécifié par l’application Options régionales et linguistiques dans Panneau de configuration, mais sans secondes. Cet indicateur ne peut pas être combiné avec FDTF_LONGTIME.

La courte durée a été correctement mise en forme.

FDTF_SHORTDATE (0x00000002)

0x00000002. Met en forme la date comme spécifié par le format de date court dans l’application Options régionales et linguistiques dans Panneau de configuration. Cet indicateur ne peut pas être combiné avec FDTF_LONGDATE.

La date courte a été correctement mise en forme.

FDTF_DEFAULT

Équivalent à FDTF_SHORTDATE | FDTF_SHORTTIME.

FDTF_LONGDATE (0x00000004)

0x00000004. Met en forme la date comme spécifié par le format de date longue dans l’application Options régionales et linguistiques dans Panneau de configuration. Cet indicateur ne peut pas être combiné avec FDTF_SHORTDATE.

La date longue a été correctement mise en forme.

FDTF_LONGTIME (0x00000008)

0x00000008. Met en forme l’heure de la journée comme spécifié par l’application Options régionales et linguistiques dans Panneau de configuration, secondes comprises. Cet indicateur ne peut pas être combiné avec FDTF_SHORTTIME.

Le temps long a été correctement mis en forme.

FDTF_RELATIVE (0x00000010)

0x00000010. Si l’indicateur de FDTF_LONGDATE est défini et que la date dans la structure FILETIME correspond à la même date d’appel de SHFormatDateTime , le jour de la semaine (le cas échéant) est remplacé par « Aujourd’hui ». Si la date dans la structure est le jour précédent, le jour de la semaine (le cas échéant) est remplacé par « Hier ».

La notation relative a été utilisée pour la date.

FDTF_LTRDATE (0x00000100)

0x00000100. Ajoute des marques pour la disposition de lecture de gauche à droite. Cet indicateur ne peut pas être combiné avec FDTF_RTLDATE.

FDTF_RTLDATE (0x00000200)

0x00000200. Ajoute des marques pour la disposition de lecture de droite à gauche. Cet indicateur ne peut pas être combiné avec FDTF_LTRDATE.

FDTF_NOAUTOREADINGORDER (0x00000400)

0x00000400. Aucune marque d’ordre de lecture n’est insérée. Normalement, en l’absence de l’indicateur FDTF_LTRDATE ou FDTF_RTLDATE, SHFormatDateTime détermine l’ordre de lecture à partir des paramètres régionaux par défaut de l’utilisateur, insère des marques d’ordre de lecture et met à jour la valeur de sortie pdwFlags de manière appropriée. Cet indicateur empêche ce processus de se produire. Il est généralement utilisé par les appelants hérités de SHFormatDateTime. Cet indicateur ne peut pas être combiné avec FDTF_RTLDATE ou FDTF_LTRDATE.

Windows Server 2003 et Windows XP : Cette valeur n’est pas disponible.

Lorsque la fonction retourne, la valeur DWORD pointée par ce paramètre peut contenir zéro ou plusieurs des indicateurs suivants.

[out] pszBuf

Type : LPTSTR

Pointeur vers une mémoire tampon qui reçoit la date et l’heure mises en forme. La mémoire tampon doit être suffisamment grande pour contenir le nombre de caractères TCHAR spécifiés par le paramètre cchBuf , y compris un caractère null de fin.

cchBuf

Type : UINT

Nombre de TCHAR pouvant être contenus par la mémoire tampon pointée par pszBuf.

Valeur retournée

Type : int

Retourne le nombre de TCHAR écrits dans la mémoire tampon, y compris le caractère null de fin. En cas d’échec, cette valeur est 0.

Remarques

Notes

L’en-tête shlwapi.h définit SHFormatDateTime comme alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. La combinaison de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows XP [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2003 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	shlwapi.h
Bibliothèque	Shlwapi.lib
DLL	Shlwapi.dll (version 5.0 ou ultérieure)

Voir aussi

GetDateFormat

GetTimeFormat