GetDurationFormat, fonction (winnls.h)

Article
08/27/2023

Met en forme une durée sous forme de chaîne de temps pour un paramètre régional spécifié par l’identificateur.

Note Pour des raisons d’interopérabilité, l’application doit préférer la fonction GetDurationFormatEx à GetDurationFormat , car Microsoft migre vers l’utilisation de noms de paramètres régionaux au lieu d’identificateurs régionaux pour les nouveaux paramètres régionaux. Toute application qui s’exécute uniquement sur Windows Vista et versions ultérieures doit utiliser GetDurationFormatEx.

Syntaxe

int GetDurationFormat(
  [in]            LCID             Locale,
  [in]            DWORD            dwFlags,
  [in, optional]  const SYSTEMTIME *lpDuration,
  [in]            ULONGLONG        ullDuration,
  [in, optional]  LPCWSTR          lpFormat,
  [out, optional] LPWSTR           lpDurationStr,
  [in]            int              cchDuration
);

Paramètres

[in] Locale

Identificateur de paramètres régionaux qui spécifie les paramètres régionaux pour lesquels cette fonction met en forme la durée. Vous pouvez utiliser la macro MAKELCID pour créer un identificateur de paramètres régionaux ou utiliser l’une des valeurs prédéfinies suivantes.

Windows Vista et versions ultérieures : Les identificateurs de paramètres régionaux personnalisés suivants sont également pris en charge.

[in] dwFlags

Indicateurs spécifiant des options de fonction. Si lpFormat n’est pas défini sur NULL, ce paramètre doit avoir la valeur 0. Si lpFormat est défini sur NULL, votre application peut spécifier LOCALE_NOUSEROVERRIDE pour mettre en forme la chaîne à l’aide du format de durée par défaut du système pour les paramètres régionaux spécifiés.

Attention L’utilisation de LOCALE_NOUSEROVERRIDE est fortement déconseillée, car elle désactive les préférences utilisateur.

[in, optional] lpDuration

Pointeur vers une structure SYSTEMTIME qui contient les informations de durée à mettre en forme. Si ce pointeur a la valeur NULL, la fonction ignore ce paramètre et utilise ullDuration.

[in] ullDuration

Entier non signé 64 bits qui représente le nombre d’intervalles de 100 nanosecondes dans la durée. Si lpDuration et ullDuration sont présents, lpDuration est prioritaire. Si lpDuration a la valeur NULL et que ullDuration a la valeur 0, la durée est égale à zéro.

[in, optional] lpFormat

Pointeur vers la chaîne de format. Pour plus d’informations, consultez le paramètre lpFormat de GetDurationFormatEx.

[out, optional] lpDurationStr

Pointeur vers la mémoire tampon dans laquelle la fonction récupère la chaîne de durée.

Ce paramètre peut également contenir NULL si cchDuration a la valeur 0. Dans ce cas, la fonction retourne la taille requise pour la mémoire tampon de chaîne de durée.

[in] cchDuration

Taille, en caractères, de la mémoire tampon indiquée par lpDurationStr.

L’application peut également définir ce paramètre sur 0. Dans ce cas, la fonction récupère NULL dans lpDurationStr et retourne la taille requise pour la mémoire tampon de chaîne de durée.

Valeur retournée

Retourne le nombre de caractères récupérés dans la mémoire tampon indiqué par lpDurationStr en cas de réussite. Si lpDurationStr est défini sur NULL et que cchDuration a la valeur 0, la fonction retourne la taille requise pour la mémoire tampon de chaîne de durée, y compris le caractère de fin Null. Par exemple, si 10 caractères sont écrits dans la mémoire tampon, la fonction retourne 11 pour inclure le caractère null de fin.

La fonction retourne 0 si elle ne réussit pas. Pour obtenir des informations d’erreur étendues, l’application peut appeler GetLastError, qui peut retourner l’un des codes d’erreur suivants :

ERROR_INSUFFICIENT_BUFFER. Une taille de mémoire tampon fournie n’était pas suffisamment grande ou a été incorrectement définie sur NULL.
ERROR_INVALID_PARAMETER. L’une des valeurs de paramètre n’était pas valide.

Remarques

Consultez Les remarques relatives à GetDurationFormatEx.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2008 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	winnls.h (inclure Windows.h)
Bibliothèque	Kernel32.lib
DLL	Kernel32.dll