ホーム › System.Ole › VarTokenizeFormatString

VarTokenizeFormatString

関数

書式文字列を解析しトークン列に変換する。

DLLOLEAUT32.dll呼出規約winapi

シグネチャ

// OLEAUT32.dll
#include <windows.h>

HRESULT VarTokenizeFormatString(
    LPWSTR pstrFormat,   // optional
    BYTE* rgbTok,
    INT cbTok,
    VARFORMAT_FIRST_DAY iFirstDay,
    VARFORMAT_FIRST_WEEK iFirstWeek,
    DWORD lcid,
    INT* pcbActual   // optional
);

パラメーター

名前

型

方向

説明

pstrFormat

LPWSTR

inoptional

書式文字列。例: "mm-dd-yy"。

rgbTok

BYTE*

inout

出力先のトークンバッファ。

cbTok

INT

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

iFirstDay

VARFORMAT_FIRST_DAY

週の最初の曜日。

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

iFirstWeek

VARFORMAT_FIRST_WEEK

年の最初の週。

値	意味
0	システムの既定値。
1	最初の週には 1 月 1 日が含まれます。
2	最初の週の大半（4 日以上）が現在の年に含まれます。
3	最初の週は 7 日間あります。

lcid

DWORD

書式文字列を解釈する際に使用するロケール。

pcbActual

INT*

inoptional

最初に生成されたトークンが設定される整数を指します。このパラメーターには NULL を指定できます。

戻り値の型: HRESULT

公式ドキュメント

実際の書式文字列を一連のトークンに解析します。これらのトークンは VarFormatFromTokens を使用して variant を書式設定する際に利用できます。

戻り値

この関数は次のいずれかの値を返すことがあります。

戻り値	説明
S_OK	成功しました。
E_INVALIDARG	1 つ以上の引数が無効です。
DISP_E_BUFFERTOOSMALL	出力先のトークンバッファが小さすぎます。

解説(Remarks)

書式文字列を一度だけ解析して繰り返し使用する方が、通常は VarFormat を繰り返し呼び出すよりも高速です。後者のルーチンは呼び出しごとに VarTokenizeFormatString を呼び出すためです。

渡すロケールは書式文字列の解釈方法を制御するものであり、VarFormatFromTokens の実際の出力の見た目を制御するものではありません。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// OLEAUT32.dll
#include <windows.h>

HRESULT VarTokenizeFormatString(
    LPWSTR pstrFormat,   // optional
    BYTE* rgbTok,
    INT cbTok,
    VARFORMAT_FIRST_DAY iFirstDay,
    VARFORMAT_FIRST_WEEK iFirstWeek,
    DWORD lcid,
    INT* pcbActual   // optional
);

[DllImport("OLEAUT32.dll", ExactSpelling = true)]
static extern int VarTokenizeFormatString(
    [MarshalAs(UnmanagedType.LPWStr)] string pstrFormat,   // LPWSTR optional
    IntPtr rgbTok,   // BYTE* in/out
    int cbTok,   // INT
    int iFirstDay,   // VARFORMAT_FIRST_DAY
    int iFirstWeek,   // VARFORMAT_FIRST_WEEK
    uint lcid,   // DWORD
    IntPtr pcbActual   // INT* optional
);

<DllImport("OLEAUT32.dll", ExactSpelling:=True)>
Public Shared Function VarTokenizeFormatString(
    <MarshalAs(UnmanagedType.LPWStr)> pstrFormat As String,   ' LPWSTR optional
    rgbTok As IntPtr,   ' BYTE* in/out
    cbTok As Integer,   ' INT
    iFirstDay As Integer,   ' VARFORMAT_FIRST_DAY
    iFirstWeek As Integer,   ' VARFORMAT_FIRST_WEEK
    lcid As UInteger,   ' DWORD
    pcbActual As IntPtr   ' INT* optional
) As Integer
End Function

' pstrFormat : LPWSTR optional
' rgbTok : BYTE* in/out
' cbTok : INT
' iFirstDay : VARFORMAT_FIRST_DAY
' iFirstWeek : VARFORMAT_FIRST_WEEK
' lcid : DWORD
' pcbActual : INT* optional
Declare PtrSafe Function VarTokenizeFormatString Lib "oleaut32" ( _
    ByVal pstrFormat As LongPtr, _
    ByVal rgbTok As LongPtr, _
    ByVal cbTok As Long, _
    ByVal iFirstDay As Long, _
    ByVal iFirstWeek As Long, _
    ByVal lcid As Long, _
    ByVal pcbActual As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

VarTokenizeFormatString = ctypes.windll.oleaut32.VarTokenizeFormatString
VarTokenizeFormatString.restype = ctypes.c_int
VarTokenizeFormatString.argtypes = [
    wintypes.LPCWSTR,  # pstrFormat : LPWSTR optional
    ctypes.POINTER(ctypes.c_ubyte),  # rgbTok : BYTE* in/out
    ctypes.c_int,  # cbTok : INT
    ctypes.c_int,  # iFirstDay : VARFORMAT_FIRST_DAY
    ctypes.c_int,  # iFirstWeek : VARFORMAT_FIRST_WEEK
    wintypes.DWORD,  # lcid : DWORD
    ctypes.POINTER(ctypes.c_int),  # pcbActual : INT* optional
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLEAUT32.dll')
VarTokenizeFormatString = Fiddle::Function.new(
  lib['VarTokenizeFormatString'],
  [
    Fiddle::TYPE_VOIDP,  # pstrFormat : LPWSTR optional
    Fiddle::TYPE_VOIDP,  # rgbTok : BYTE* in/out
    Fiddle::TYPE_INT,  # cbTok : INT
    Fiddle::TYPE_INT,  # iFirstDay : VARFORMAT_FIRST_DAY
    Fiddle::TYPE_INT,  # iFirstWeek : VARFORMAT_FIRST_WEEK
    -Fiddle::TYPE_INT,  # lcid : DWORD
    Fiddle::TYPE_VOIDP,  # pcbActual : INT* optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "oleaut32")]
extern "system" {
    fn VarTokenizeFormatString(
        pstrFormat: *mut u16,  // LPWSTR optional
        rgbTok: *mut u8,  // BYTE* in/out
        cbTok: i32,  // INT
        iFirstDay: i32,  // VARFORMAT_FIRST_DAY
        iFirstWeek: i32,  // VARFORMAT_FIRST_WEEK
        lcid: u32,  // DWORD
        pcbActual: *mut i32  // INT* optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("OLEAUT32.dll")]
public static extern int VarTokenizeFormatString([MarshalAs(UnmanagedType.LPWStr)] string pstrFormat, IntPtr rgbTok, int cbTok, int iFirstDay, int iFirstWeek, uint lcid, IntPtr pcbActual);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLEAUT32_VarTokenizeFormatString' -Namespace Win32 -PassThru
# $api::VarTokenizeFormatString(pstrFormat, rgbTok, cbTok, iFirstDay, iFirstWeek, lcid, pcbActual)

#uselib "OLEAUT32.dll"
#func global VarTokenizeFormatString "VarTokenizeFormatString" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; VarTokenizeFormatString pstrFormat, varptr(rgbTok), cbTok, iFirstDay, iFirstWeek, lcid, varptr(pcbActual)   ; 戻り値は stat
; pstrFormat : LPWSTR optional -> "sptr"
; rgbTok : BYTE* in/out -> "sptr"
; cbTok : INT -> "sptr"
; iFirstDay : VARFORMAT_FIRST_DAY -> "sptr"
; iFirstWeek : VARFORMAT_FIRST_WEEK -> "sptr"
; lcid : DWORD -> "sptr"
; pcbActual : INT* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "OLEAUT32.dll"
#cfunc global VarTokenizeFormatString "VarTokenizeFormatString" wstr, var, int, int, int, int, var
; res = VarTokenizeFormatString(pstrFormat, rgbTok, cbTok, iFirstDay, iFirstWeek, lcid, pcbActual)
; pstrFormat : LPWSTR optional -> "wstr"
; rgbTok : BYTE* in/out -> "var"
; cbTok : INT -> "int"
; iFirstDay : VARFORMAT_FIRST_DAY -> "int"
; iFirstWeek : VARFORMAT_FIRST_WEEK -> "int"
; lcid : DWORD -> "int"
; pcbActual : INT* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "OLEAUT32.dll"
#cfunc global VarTokenizeFormatString "VarTokenizeFormatString" wstr, sptr, int, int, int, int, sptr
; res = VarTokenizeFormatString(pstrFormat, varptr(rgbTok), cbTok, iFirstDay, iFirstWeek, lcid, varptr(pcbActual))
; pstrFormat : LPWSTR optional -> "wstr"
; rgbTok : BYTE* in/out -> "sptr"
; cbTok : INT -> "int"
; iFirstDay : VARFORMAT_FIRST_DAY -> "int"
; iFirstWeek : VARFORMAT_FIRST_WEEK -> "int"
; lcid : DWORD -> "int"
; pcbActual : INT* optional -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。