Fonction VarTokenizeFormatString (oleauto.h)

Article
03/01/2024

Analyse la chaîne de format réelle dans une série de jetons qui peuvent être utilisés pour mettre en forme des variantes à l’aide de VarFormatFromTokens.

Syntaxe

HRESULT VarTokenizeFormatString(
  [in, optional] LPOLESTR pstrFormat,
  [in, out]      LPBYTE   rgbTok,
  [in]           int      cbTok,
  [in]           int      iFirstDay,
  [in]           int      iFirstWeek,
  [in]           LCID     lcid,
  [in, optional] int      *pcbActual
);

Paramètres

[in, optional] pstrFormat

Chaîne de format. Par exemple , « mm-dd-yy ».

[in, out] rgbTok

Mémoire tampon de jeton de destination.

[in] cbTok

Taille de la mémoire tampon de jeton de destination.

[in] iFirstDay

Premier jour de la semaine.

Valeur	Signification
0	Valeur par défaut du système
1	Lundi
2	Mardi
3	Mercredi
4	Jeudi
5	Vendredi
6	Samedi
7	Dimanche

[in] iFirstWeek

Première semaine de l’année.

Valeur	Signification
0	Valeur par défaut du système.
1	La première semaine contient le 1er janvier.
2	La plus grande moitié (quatre jours) de la première semaine se situe dans l’année en cours.
3	La première semaine a sept jours.

[in] lcid

Paramètres régionaux pour interpréter la chaîne de format.

[in, optional] pcbActual

Pointe vers l’entier qui est défini sur le premier jeton généré. Ce paramètre peut être NULL.

Valeur retournée

Cette fonction peut retourner l’une de ces valeurs.

Code de retour	Description
S_OK	Réussite.
E_INVALIDARG	Un ou plusieurs arguments ne sont pas valides.
DISP_E_BUFFERTOOSMALL	La mémoire tampon de jeton de destination est trop petite.

Remarques

Analyser une seule fois la chaîne de format et l’utiliser à plusieurs reprises est généralement plus rapide que d’appeler VarFormat à plusieurs reprises, car cette dernière routine appelle VarTokenizeFormatString pour chaque appel.

Les paramètres régionaux que vous transmettez contrôlent l’interprétation de la chaîne de format, et non l’apparence de la sortie réelle de VarFormatFromTokens .

Configuration requise

Condition requise	Valeur
Plateforme cible	Windows
En-tête	oleauto.h
Bibliothèque	OleAut32.lib
DLL	OleAut32.dll

Partager via