VarTokenizeFormatString 関数 (oleauto.h)

VarFormatFromTokens を使用してバリアントの書式を設定するために使用できる一連のトークンに、実際の書式指定文字列を解析します。

構文

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
);

パラメーター

[in, optional] pstrFormat

書式指定文字列。 たとえば、"mm-dd-yy" です。

[in, out] rgbTok

宛先トークン バッファー。

[in] cbTok

宛先トークン バッファーのサイズ。

[in] iFirstDay

週の最初の日。

値	意味
0	システムの既定値
1	月曜日
2	Tuesday
3	水曜日
4	Thursday
5	金曜日
6	土曜日
7	土曜日

[in] iFirstWeek

年の最初の週。

値	意味
0	システムの既定値。
1	最初の週には、1 月 1 日が含まれます。
2	最初の週の大きな半分 (4 日間) は、現在の年です。
3	最初の週は 7 日間です。

[in] lcid

書式指定文字列を解釈するロケール。

[in, optional] pcbActual

最初に生成されたトークンに設定されている整数を指します。 このパラメーターは、NULL でもかまいません。

戻り値

この関数は、これらの値のいずれかを返すことができます。

リターン コード	説明
S_OK	正常終了しました。
E_INVALIDARG	1 つ以上の引数が無効です。
DISP_E_BUFFERTOOSMALL	宛先トークン バッファーが小さすぎます。

注釈

書式指定文字列を 1 回解析してから繰り返し使用する方が、通常、 VarFormat を繰り返し呼び出すよりも高速です。後者のルーチンでは、呼び出しごとに VarTokenizeFormatString が呼び出されるためです。

渡すロケールは、 VarFormatFromTokens の実際の出力の外観ではなく、書式指定文字列の解釈方法を制御します。

要件

要件	値
対象プラットフォーム	Windows
ヘッダー	oleauto.h
Library	OleAut32.lib
[DLL]	OleAut32.dll