Win32 API 日本語リファレンス
ホーム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
);

パラメーター

名前方向
pstrFormatLPWSTRinoptional
rgbTokBYTE*inout
cbTokINTin
iFirstDayVARFORMAT_FIRST_DAYin
iFirstWeekVARFORMAT_FIRST_WEEKin
lcidDWORDin
pcbActualINT*inoptional

戻り値の型: HRESULT

各言語での呼び出し定義

// 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 方式にも切替可。
出力引数:
; HRESULT VarTokenizeFormatString(LPWSTR pstrFormat, BYTE* rgbTok, INT cbTok, VARFORMAT_FIRST_DAY iFirstDay, VARFORMAT_FIRST_WEEK iFirstWeek, DWORD lcid, INT* pcbActual)
#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 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	oleaut32 = windows.NewLazySystemDLL("OLEAUT32.dll")
	procVarTokenizeFormatString = oleaut32.NewProc("VarTokenizeFormatString")
)

// pstrFormat (LPWSTR optional), rgbTok (BYTE* in/out), cbTok (INT), iFirstDay (VARFORMAT_FIRST_DAY), iFirstWeek (VARFORMAT_FIRST_WEEK), lcid (DWORD), pcbActual (INT* optional)
r1, _, err := procVarTokenizeFormatString.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pstrFormat))),
	uintptr(rgbTok),
	uintptr(cbTok),
	uintptr(iFirstDay),
	uintptr(iFirstWeek),
	uintptr(lcid),
	uintptr(pcbActual),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function VarTokenizeFormatString(
  pstrFormat: PWideChar;   // LPWSTR optional
  rgbTok: Pointer;   // BYTE* in/out
  cbTok: Integer;   // INT
  iFirstDay: Integer;   // VARFORMAT_FIRST_DAY
  iFirstWeek: Integer;   // VARFORMAT_FIRST_WEEK
  lcid: DWORD;   // DWORD
  pcbActual: Pointer   // INT* optional
): Integer; stdcall;
  external 'OLEAUT32.dll' name 'VarTokenizeFormatString';
result := DllCall("OLEAUT32\VarTokenizeFormatString"
    , "WStr", pstrFormat   ; LPWSTR optional
    , "Ptr", rgbTok   ; BYTE* in/out
    , "Int", cbTok   ; INT
    , "Int", iFirstDay   ; VARFORMAT_FIRST_DAY
    , "Int", iFirstWeek   ; VARFORMAT_FIRST_WEEK
    , "UInt", lcid   ; DWORD
    , "Ptr", pcbActual   ; INT* optional
    , "Int")   ; return: HRESULT
●VarTokenizeFormatString(pstrFormat, rgbTok, cbTok, iFirstDay, iFirstWeek, lcid, pcbActual) = DLL("OLEAUT32.dll", "int VarTokenizeFormatString(char*, void*, int, int, int, dword, void*)")
# 呼び出し: VarTokenizeFormatString(pstrFormat, rgbTok, cbTok, iFirstDay, iFirstWeek, lcid, pcbActual)
# pstrFormat : LPWSTR optional -> "char*"
# rgbTok : BYTE* in/out -> "void*"
# cbTok : INT -> "int"
# iFirstDay : VARFORMAT_FIRST_DAY -> "int"
# iFirstWeek : VARFORMAT_FIRST_WEEK -> "int"
# lcid : DWORD -> "dword"
# pcbActual : INT* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。