VarParseNumFromStr

関数

文字列を解析し数値情報をNUMPARSE構造体に取り出す。

DLLOLEAUT32.dll呼出規約winapi

シグネチャ

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

HRESULT VarParseNumFromStr(
    LPCWSTR strIn,
    DWORD lcid,
    DWORD dwFlags,
    NUMPARSE* pnumprs,
    BYTE* rgbDig
);

パラメーター

名前	型	方向	説明
strIn	LPCWSTR	in	変換する入力文字列。
lcid	DWORD	in	ロケール識別子。
dwFlags	DWORD	in	呼び出し元が解析を制御できるようにし、数値として受け入れ可能な構文を定義します。このフィールドを 0 に設定した場合、入力文字列には 10 進数の数字以外を含めることはできません。定義された各フラグビットを設定すると、その構文要素の解析が有効になります。標準的なオートメーション解析(例えば VarI2FromStr で使用されるもの)では、すべてのフラグが設定されています(NUMPRS_STD)。
pnumprs	NUMPARSE*	inout	解析結果。
rgbDig	BYTE*	out	数値が 8 進数、10 進数、16 進数のいずれであるかに応じて、0〜7、0〜9、または 0〜15 の範囲の各桁の値。先頭のゼロはすべて取り除かれています。10 進数の場合、末尾のゼロも取り除かれますが、数値がゼロの場合は例外で、その場合は 1 桁のゼロが存在します。

戻り値の型: HRESULT

公式ドキュメント

文字列を解析し、それが表す数値の型に依存しない記述を作成します。

戻り値

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

戻り値	説明
S_OK	成功しました。
E_OUTOFMEMORY	内部のメモリ割り当てに失敗しました。(DBCS の場合にのみ、すべての全角文字を半角にマップしたコピーを作成するために使用されます。)
DISP_E_TYPEMISMATCH	文字列に有効な数値が存在しないか、開き括弧に対応する閉じ括弧が存在しません。前者の場合、NUMPARSE 構造体の cDig および cchUsed は 0 になります。後者の場合、NUMPARSE 構造体と桁配列は、閉じ括弧が存在していたかのように完全に更新されます。
DISP_E_OVERFLOW	16 進数および 8 進数の場合、配列に収まりきらない桁数があります。10 進数の場合、指数が可能な最大値を超えています。いずれの場合も、NUMPARSE 構造体と桁配列は完全に更新されます(10 進数の場合、cchUsed フィールドには指数全体が含まれません)。

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

各言語での呼び出し定義

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

HRESULT VarParseNumFromStr(
    LPCWSTR strIn,
    DWORD lcid,
    DWORD dwFlags,
    NUMPARSE* pnumprs,
    BYTE* rgbDig
);

[DllImport("OLEAUT32.dll", ExactSpelling = true)]
static extern int VarParseNumFromStr(
    [MarshalAs(UnmanagedType.LPWStr)] string strIn,   // LPCWSTR
    uint lcid,   // DWORD
    uint dwFlags,   // DWORD
    IntPtr pnumprs,   // NUMPARSE* in/out
    IntPtr rgbDig   // BYTE* out
);

<DllImport("OLEAUT32.dll", ExactSpelling:=True)>
Public Shared Function VarParseNumFromStr(
    <MarshalAs(UnmanagedType.LPWStr)> strIn As String,   ' LPCWSTR
    lcid As UInteger,   ' DWORD
    dwFlags As UInteger,   ' DWORD
    pnumprs As IntPtr,   ' NUMPARSE* in/out
    rgbDig As IntPtr   ' BYTE* out
) As Integer
End Function

' strIn : LPCWSTR
' lcid : DWORD
' dwFlags : DWORD
' pnumprs : NUMPARSE* in/out
' rgbDig : BYTE* out
Declare PtrSafe Function VarParseNumFromStr Lib "oleaut32" ( _
    ByVal strIn As LongPtr, _
    ByVal lcid As Long, _
    ByVal dwFlags As Long, _
    ByVal pnumprs As LongPtr, _
    ByVal rgbDig As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

VarParseNumFromStr = ctypes.windll.oleaut32.VarParseNumFromStr
VarParseNumFromStr.restype = ctypes.c_int
VarParseNumFromStr.argtypes = [
    wintypes.LPCWSTR,  # strIn : LPCWSTR
    wintypes.DWORD,  # lcid : DWORD
    wintypes.DWORD,  # dwFlags : DWORD
    ctypes.c_void_p,  # pnumprs : NUMPARSE* in/out
    ctypes.POINTER(ctypes.c_ubyte),  # rgbDig : BYTE* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLEAUT32.dll')
VarParseNumFromStr = Fiddle::Function.new(
  lib['VarParseNumFromStr'],
  [
    Fiddle::TYPE_VOIDP,  # strIn : LPCWSTR
    -Fiddle::TYPE_INT,  # lcid : DWORD
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # pnumprs : NUMPARSE* in/out
    Fiddle::TYPE_VOIDP,  # rgbDig : BYTE* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "oleaut32")]
extern "system" {
    fn VarParseNumFromStr(
        strIn: *const u16,  // LPCWSTR
        lcid: u32,  // DWORD
        dwFlags: u32,  // DWORD
        pnumprs: *mut NUMPARSE,  // NUMPARSE* in/out
        rgbDig: *mut u8  // BYTE* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("OLEAUT32.dll")]
public static extern int VarParseNumFromStr([MarshalAs(UnmanagedType.LPWStr)] string strIn, uint lcid, uint dwFlags, IntPtr pnumprs, IntPtr rgbDig);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLEAUT32_VarParseNumFromStr' -Namespace Win32 -PassThru
# $api::VarParseNumFromStr(strIn, lcid, dwFlags, pnumprs, rgbDig)

#uselib "OLEAUT32.dll"
#func global VarParseNumFromStr "VarParseNumFromStr" sptr, sptr, sptr, sptr, sptr
; VarParseNumFromStr strIn, lcid, dwFlags, varptr(pnumprs), varptr(rgbDig)   ; 戻り値は stat
; strIn : LPCWSTR -> "sptr"
; lcid : DWORD -> "sptr"
; dwFlags : DWORD -> "sptr"
; pnumprs : NUMPARSE* in/out -> "sptr"
; rgbDig : BYTE* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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