Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

VarFormat function

Formats a variant into string form by parsing a format string.

Syntax


HRESULT VarFormat(
  _In_     LPVARIANT pvarIn,
  _In_opt_ LPOLESTR  pstrFormat,
  _In_     int       iFirstDay,
  _In_     int       iFirstWeek,
  _In_     ULONG     dwFlags,
  _Out_    BSTR      *pbstrOut
);

Parameters

pvarIn [in]

The variant.

pstrFormat [in, optional]

The format string. For example "mm-dd-yy".

iFirstDay [in]

First day of the week.

ValueMeaning
0

The system default

1

Monday

2

Tuesday

3

Wednesday

4

Thursday

5

Friday

6

Saturday

7

Sunday

 

iFirstWeek [in]

First week of the year.

ValueMeaning
0

The system default.

1

The first week contains January 1st.

2

The larger half (four days) of the first week is in the current year.

3

The first week has seven days.

 

dwFlags [in]

Flags that control the formatting process. The only flags that can be set are VAR_CALENDAR_HIJRI or VAR_FORMAT_NOSUBSTITUTE.

pbstrOut [out]

The formatted string that represents the variant.

Return value

This function can return one of these values.

Return codeDescription
S_OK

Success.

E_INVALIDARG

One or more of the arguments is not valid.

 

Remarks

This function uses the user's default locale while calling VarTokenizeFormatString and VarFormatFromTokens.

Requirements

Header

OleAuto.h

Library

OleAut32.lib

DLL

OleAut32.dll

See also

VarTokenizeFormatString
VarFormatFromTokens
Formatting Routines

 

 

Show:
© 2017 Microsoft