ホーム › System.Ole › VarFormatFromTokens

VarFormatFromTokens

関数

トークン化済み書式に従いVARIANT値を整形する。

DLLOLEAUT32.dll呼出規約winapi

シグネチャ

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

HRESULT VarFormatFromTokens(
    VARIANT* pvarIn,
    LPWSTR pstrFormat,   // optional
    BYTE* pbTokCur,
    DWORD dwFlags,
    LPWSTR* pbstrOut,
    DWORD lcid
);

パラメーター

名前	型	方向	説明
pvarIn	VARIANT*	in	書式設定する値を格納した variant です。
pstrFormat	LPWSTR	inoptional	元の書式文字列です。
pbTokCur	BYTE*	in	VarTokenizeFormatString によってトークン化された書式文字列です。
dwFlags	DWORD	in	設定できるフラグは VAR_CALENDAR_HIJRI または VAR_FORMAT_NOSUBSTITUTE のみです。
pbstrOut	LPWSTR*	out	書式設定された出力文字列です。
lcid	DWORD	in	書式設定された出力文字列に使用するロケールです。

戻り値の型: HRESULT

公式ドキュメント

トークン化された書式文字列を variant に適用し、書式設定された出力文字列を生成します。

戻り値

この関数は次のいずれかの値を返します。

戻り値	説明
S_OK	成功しました。
E_OUTOFMEMORY	メモリが不足しています。
E_INVALIDARG	1 つ以上の引数が無効です。
DISP_E_TYPEMISMATCH	引数を指定された型に変換できませんでした。

解説(Remarks)

ロケール lcid によって、書式設定された出力文字列が制御されます。

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

各言語での呼び出し定義

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

HRESULT VarFormatFromTokens(
    VARIANT* pvarIn,
    LPWSTR pstrFormat,   // optional
    BYTE* pbTokCur,
    DWORD dwFlags,
    LPWSTR* pbstrOut,
    DWORD lcid
);

[DllImport("OLEAUT32.dll", ExactSpelling = true)]
static extern int VarFormatFromTokens(
    IntPtr pvarIn,   // VARIANT*
    [MarshalAs(UnmanagedType.LPWStr)] string pstrFormat,   // LPWSTR optional
    IntPtr pbTokCur,   // BYTE*
    uint dwFlags,   // DWORD
    IntPtr pbstrOut,   // LPWSTR* out
    uint lcid   // DWORD
);

<DllImport("OLEAUT32.dll", ExactSpelling:=True)>
Public Shared Function VarFormatFromTokens(
    pvarIn As IntPtr,   ' VARIANT*
    <MarshalAs(UnmanagedType.LPWStr)> pstrFormat As String,   ' LPWSTR optional
    pbTokCur As IntPtr,   ' BYTE*
    dwFlags As UInteger,   ' DWORD
    pbstrOut As IntPtr,   ' LPWSTR* out
    lcid As UInteger   ' DWORD
) As Integer
End Function

' pvarIn : VARIANT*
' pstrFormat : LPWSTR optional
' pbTokCur : BYTE*
' dwFlags : DWORD
' pbstrOut : LPWSTR* out
' lcid : DWORD
Declare PtrSafe Function VarFormatFromTokens Lib "oleaut32" ( _
    ByVal pvarIn As LongPtr, _
    ByVal pstrFormat As LongPtr, _
    ByVal pbTokCur As LongPtr, _
    ByVal dwFlags As Long, _
    ByVal pbstrOut As LongPtr, _
    ByVal lcid As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

VarFormatFromTokens = ctypes.windll.oleaut32.VarFormatFromTokens
VarFormatFromTokens.restype = ctypes.c_int
VarFormatFromTokens.argtypes = [
    ctypes.c_void_p,  # pvarIn : VARIANT*
    wintypes.LPCWSTR,  # pstrFormat : LPWSTR optional
    ctypes.POINTER(ctypes.c_ubyte),  # pbTokCur : BYTE*
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.c_void_p,  # pbstrOut : LPWSTR* out
    wintypes.DWORD,  # lcid : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLEAUT32.dll')
VarFormatFromTokens = Fiddle::Function.new(
  lib['VarFormatFromTokens'],
  [
    Fiddle::TYPE_VOIDP,  # pvarIn : VARIANT*
    Fiddle::TYPE_VOIDP,  # pstrFormat : LPWSTR optional
    Fiddle::TYPE_VOIDP,  # pbTokCur : BYTE*
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pbstrOut : LPWSTR* out
    -Fiddle::TYPE_INT,  # lcid : DWORD
  ],
  Fiddle::TYPE_INT)

#[link(name = "oleaut32")]
extern "system" {
    fn VarFormatFromTokens(
        pvarIn: *mut VARIANT,  // VARIANT*
        pstrFormat: *mut u16,  // LPWSTR optional
        pbTokCur: *mut u8,  // BYTE*
        dwFlags: u32,  // DWORD
        pbstrOut: *mut *mut u16,  // LPWSTR* out
        lcid: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("OLEAUT32.dll")]
public static extern int VarFormatFromTokens(IntPtr pvarIn, [MarshalAs(UnmanagedType.LPWStr)] string pstrFormat, IntPtr pbTokCur, uint dwFlags, IntPtr pbstrOut, uint lcid);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLEAUT32_VarFormatFromTokens' -Namespace Win32 -PassThru
# $api::VarFormatFromTokens(pvarIn, pstrFormat, pbTokCur, dwFlags, pbstrOut, lcid)

#uselib "OLEAUT32.dll"
#func global VarFormatFromTokens "VarFormatFromTokens" sptr, sptr, sptr, sptr, sptr, sptr
; VarFormatFromTokens varptr(pvarIn), pstrFormat, varptr(pbTokCur), dwFlags, varptr(pbstrOut), lcid   ; 戻り値は stat
; pvarIn : VARIANT* -> "sptr"
; pstrFormat : LPWSTR optional -> "sptr"
; pbTokCur : BYTE* -> "sptr"
; dwFlags : DWORD -> "sptr"
; pbstrOut : LPWSTR* out -> "sptr"
; lcid : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "OLEAUT32.dll"
#cfunc global VarFormatFromTokens "VarFormatFromTokens" var, wstr, var, int, var, int
; res = VarFormatFromTokens(pvarIn, pstrFormat, pbTokCur, dwFlags, pbstrOut, lcid)
; pvarIn : VARIANT* -> "var"
; pstrFormat : LPWSTR optional -> "wstr"
; pbTokCur : BYTE* -> "var"
; dwFlags : DWORD -> "int"
; pbstrOut : LPWSTR* out -> "var"
; lcid : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "OLEAUT32.dll"
#cfunc global VarFormatFromTokens "VarFormatFromTokens" sptr, wstr, sptr, int, sptr, int
; res = VarFormatFromTokens(varptr(pvarIn), pstrFormat, varptr(pbTokCur), dwFlags, varptr(pbstrOut), lcid)
; pvarIn : VARIANT* -> "sptr"
; pstrFormat : LPWSTR optional -> "wstr"
; pbTokCur : BYTE* -> "sptr"
; dwFlags : DWORD -> "int"
; pbstrOut : LPWSTR* out -> "sptr"
; lcid : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。