RoParseTypeName
関数シグネチャ
// api-ms-win-ro-typeresolution-l1-1-0.dll
#include <windows.h>
HRESULT RoParseTypeName(
HSTRING typeName,
DWORD* partsCount,
HSTRING** typeNameParts
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| typeName | HSTRING | in | 文字列としてエンコードされた型名。型名には、名前空間で修飾されていない型、パラメーター化されていない名前空間修飾型、または完全にインスタンス化された名前空間修飾のパラメーター化型を指定できます。 |
| partsCount | DWORD* | out | typenameParts 配列の要素数。 |
| typeNameParts | HSTRING** | out | 配列の最初の要素は指定された型で、残りの要素には型パラメーター (存在する場合) が前順 (prewalk) のツリー走査順で格納されます。 |
戻り値の型: HRESULT
公式ドキュメント
型名を解析します。パラメーター化された型の場合は、既存の型パラメーターも解析します。
戻り値
型: HRESULT
この関数は次のいずれかの値を返します。
| リターンコード | 説明 |
|---|---|
| 解析に成功しました。 | |
| typeName に埋め込みの null が含まれているか、typeName が空です。 | |
| typename の形式が正しくありません。 |
解説(Remarks)
RoParseTypeName 関数は、文字列としてエンコードされた型名を解析し、HSTRING 値の配列を返します。配列の最初の要素は基本となる型で、残りの要素には型パラメーター (存在する場合) が行きがけ順 (pre-order) のツリー走査順で格納されます。解析に成功した場合は S_OK が返されます。
入力される型名の例を次に示します。
-
例 1 (名前空間で修飾されていない型)
-
入力の型名
String
-
出力
配列要素 0: String
-
入力の型名
-
例 2 (パラメーター化されていない名前空間修飾型)
-
入力の型名
Windows.Foundation.IExtensionInformation
-
出力
配列要素 0: Windows.Foundation.IExtensionInformation
-
入力の型名
-
例 3 (インスタンス化されたパラメーター化インターフェイス型)
-
入力の型名
Windows.Foundation.Collections.IIterator`1<Windows.Foundation.Collections.IMapView`2<Windows.Foundation.Collections.IVector`1<String>, String>>
-
出力
配列要素 0: Windows.Foundation.Collections.IIterator`1
配列要素 1: Windows.Foundation.Collections.IMapView`2
配列要素 2: Windows.Foundation.Collections.IVector`1
配列要素 3: String
配列要素 4: String
-
入力の型名
入力文字列は空であってはならず、埋め込みの null 文字を含んでいてはなりません。これに従わない場合、この API は E_INVALIDARG で失敗します。 IVector`1< のように typename の形式が正しくない場合、この API は RO_E_METADATA_INVALID_TYPE_FORMAT エラーコードで失敗します。
RoParseTypeName 関数が検証するのは typename の形式のみで、その構文は検証しません。たとえば、名前空間修飾されたパラメーター化インターフェイスの typename が次の表に示す形式に従っているかどうかは検証しますが、` 、< 、> の各文字を含めることができないという点を除き、typename に使用できる文字や記号について要件を課すことはありません。
文字列としてエンコードされた、インスタンス化済みのパラメーター化インターフェイスの形式は次のとおりです。
| パラメーター化インターフェイスの名前 | バッククォート文字 (`) | 型パラメーターの数 | 左山かっこ (<) | 各型パラメーターの名前空間修飾名 (コンマ区切り)。 | 右山かっこ (>) |
型パラメーターには次のものを指定できます。
- WinRT の基本型のような、パラメーター化されておらず名前空間でも修飾されていない型。
- パラメーター化されていない名前空間修飾型。
- 完全にインスタンス化された名前空間修飾のパラメーター化インターフェイス。
例
次の C++ の例は、指定した型名の直接の子名前空間を検索するために RoParseTypeName 関数を使用する方法を示しています。
#include <windows.h>
#include <stdio.h>
#include <WinRTString.h>
#include <TypeResolution.h>
HRESULT PrintParameterizedInterfaceParts(PCWSTR pszTypename);
int ShowUsage()
{
wprintf(L"Usage: RoParseTypeNameSample \"TypeName\"\n");
return -1;
}
int __cdecl wmain(int argc, WCHAR **argv)
{
if (argc != 2)
{
return ShowUsage();
}
HRESULT hr = PrintParameterizedInterfaceParts(argv[1]);
if (SUCCEEDED(hr))
{
return 0;
}
else
{
return -1;
}
}
HRESULT PrintParameterizedInterfaceParts(PCWSTR pszTypename)
{
HRESULT hr;
HSTRING hstrTypeName = nullptr;
HSTRING *phstrNameParts = nullptr;
DWORD cRetrievedNameParts = 0;
hr = WindowsCreateString(
pszTypename,
static_cast<UINT32>(wcslen(pszTypename)),
&hstrTypeName);
if (SUCCEEDED(hr))
{
hr = RoParseTypeName(
hstrTypeName,
&cRetrievedNameParts,
&phstrNameParts);
}
if (SUCCEEDED(hr))
{
wprintf(L"Parameterized interface %s is composed of:\n", pszTypename);
for (UINT32 i = 0; i < cRetrievedNameParts; i++)
{
wprintf(L"Element %d: %s\n", i, WindowsGetStringRawBuffer(phstrNameParts[i], nullptr));
}
}
else
{
wprintf(L"Invalid parameterized interface syntax: %s!\n", pszTypename);
}
// リソースを解放します。
if (hstrTypeName != nullptr)
{
WindowsDeleteString(hstrTypeName);
}
for (UINT32 i = 0; i < cRetrievedNameParts; i++)
{
WindowsDeleteString(phstrNameParts[i]);
}
CoTaskMemFree(phstrNameParts);
return hr;
}
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// api-ms-win-ro-typeresolution-l1-1-0.dll
#include <windows.h>
HRESULT RoParseTypeName(
HSTRING typeName,
DWORD* partsCount,
HSTRING** typeNameParts
);[DllImport("api-ms-win-ro-typeresolution-l1-1-0.dll", ExactSpelling = true)]
static extern int RoParseTypeName(
IntPtr typeName, // HSTRING
out uint partsCount, // DWORD* out
IntPtr typeNameParts // HSTRING** out
);<DllImport("api-ms-win-ro-typeresolution-l1-1-0.dll", ExactSpelling:=True)>
Public Shared Function RoParseTypeName(
typeName As IntPtr, ' HSTRING
<Out> ByRef partsCount As UInteger, ' DWORD* out
typeNameParts As IntPtr ' HSTRING** out
) As Integer
End Function' typeName : HSTRING
' partsCount : DWORD* out
' typeNameParts : HSTRING** out
Declare PtrSafe Function RoParseTypeName Lib "api-ms-win-ro-typeresolution-l1-1-0" ( _
ByVal typeName As LongPtr, _
ByRef partsCount As Long, _
ByVal typeNameParts As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
RoParseTypeName = ctypes.windll.LoadLibrary("api-ms-win-ro-typeresolution-l1-1-0.dll").RoParseTypeName
RoParseTypeName.restype = ctypes.c_int
RoParseTypeName.argtypes = [
wintypes.HANDLE, # typeName : HSTRING
ctypes.POINTER(wintypes.DWORD), # partsCount : DWORD* out
ctypes.c_void_p, # typeNameParts : HSTRING** out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('api-ms-win-ro-typeresolution-l1-1-0.dll')
RoParseTypeName = Fiddle::Function.new(
lib['RoParseTypeName'],
[
Fiddle::TYPE_VOIDP, # typeName : HSTRING
Fiddle::TYPE_VOIDP, # partsCount : DWORD* out
Fiddle::TYPE_VOIDP, # typeNameParts : HSTRING** out
],
Fiddle::TYPE_INT)#[link(name = "api-ms-win-ro-typeresolution-l1-1-0")]
extern "system" {
fn RoParseTypeName(
typeName: *mut core::ffi::c_void, // HSTRING
partsCount: *mut u32, // DWORD* out
typeNameParts: *mut *mut *mut core::ffi::c_void // HSTRING** out
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("api-ms-win-ro-typeresolution-l1-1-0.dll")]
public static extern int RoParseTypeName(IntPtr typeName, out uint partsCount, IntPtr typeNameParts);
"@
$api = Add-Type -MemberDefinition $sig -Name 'api-ms-win-ro-typeresolution-l1-1-0_RoParseTypeName' -Namespace Win32 -PassThru
# $api::RoParseTypeName(typeName, partsCount, typeNameParts)#uselib "api-ms-win-ro-typeresolution-l1-1-0.dll"
#func global RoParseTypeName "RoParseTypeName" sptr, sptr, sptr
; RoParseTypeName typeName, varptr(partsCount), typeNameParts ; 戻り値は stat
; typeName : HSTRING -> "sptr"
; partsCount : DWORD* out -> "sptr"
; typeNameParts : HSTRING** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "api-ms-win-ro-typeresolution-l1-1-0.dll" #cfunc global RoParseTypeName "RoParseTypeName" sptr, var, sptr ; res = RoParseTypeName(typeName, partsCount, typeNameParts) ; typeName : HSTRING -> "sptr" ; partsCount : DWORD* out -> "var" ; typeNameParts : HSTRING** out -> "sptr" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "api-ms-win-ro-typeresolution-l1-1-0.dll" #cfunc global RoParseTypeName "RoParseTypeName" sptr, sptr, sptr ; res = RoParseTypeName(typeName, varptr(partsCount), typeNameParts) ; typeName : HSTRING -> "sptr" ; partsCount : DWORD* out -> "sptr" ; typeNameParts : HSTRING** out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; HRESULT RoParseTypeName(HSTRING typeName, DWORD* partsCount, HSTRING** typeNameParts) #uselib "api-ms-win-ro-typeresolution-l1-1-0.dll" #cfunc global RoParseTypeName "RoParseTypeName" intptr, var, intptr ; res = RoParseTypeName(typeName, partsCount, typeNameParts) ; typeName : HSTRING -> "intptr" ; partsCount : DWORD* out -> "var" ; typeNameParts : HSTRING** out -> "intptr" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; HRESULT RoParseTypeName(HSTRING typeName, DWORD* partsCount, HSTRING** typeNameParts) #uselib "api-ms-win-ro-typeresolution-l1-1-0.dll" #cfunc global RoParseTypeName "RoParseTypeName" intptr, intptr, intptr ; res = RoParseTypeName(typeName, varptr(partsCount), typeNameParts) ; typeName : HSTRING -> "intptr" ; partsCount : DWORD* out -> "intptr" ; typeNameParts : HSTRING** out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
api_ms_win_ro_typeresolution_l1_1_0 = windows.NewLazySystemDLL("api-ms-win-ro-typeresolution-l1-1-0.dll")
procRoParseTypeName = api_ms_win_ro_typeresolution_l1_1_0.NewProc("RoParseTypeName")
)
// typeName (HSTRING), partsCount (DWORD* out), typeNameParts (HSTRING** out)
r1, _, err := procRoParseTypeName.Call(
uintptr(typeName),
uintptr(partsCount),
uintptr(typeNameParts),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // HRESULTfunction RoParseTypeName(
typeName: THandle; // HSTRING
partsCount: Pointer; // DWORD* out
typeNameParts: Pointer // HSTRING** out
): Integer; stdcall;
external 'api-ms-win-ro-typeresolution-l1-1-0.dll' name 'RoParseTypeName';result := DllCall("api-ms-win-ro-typeresolution-l1-1-0\RoParseTypeName"
, "Ptr", typeName ; HSTRING
, "Ptr", partsCount ; DWORD* out
, "Ptr", typeNameParts ; HSTRING** out
, "Int") ; return: HRESULT●RoParseTypeName(typeName, partsCount, typeNameParts) = DLL("api-ms-win-ro-typeresolution-l1-1-0.dll", "int RoParseTypeName(void*, void*, void*)")
# 呼び出し: RoParseTypeName(typeName, partsCount, typeNameParts)
# typeName : HSTRING -> "void*"
# partsCount : DWORD* out -> "void*"
# typeNameParts : HSTRING** out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "api-ms-win-ro-typeresolution-l1-1-0" fn RoParseTypeName(
typeName: ?*anyopaque, // HSTRING
partsCount: [*c]u32, // DWORD* out
typeNameParts: ?*anyopaque // HSTRING** out
) callconv(std.os.windows.WINAPI) i32;proc RoParseTypeName(
typeName: pointer, # HSTRING
partsCount: ptr uint32, # DWORD* out
typeNameParts: pointer # HSTRING** out
): int32 {.importc: "RoParseTypeName", stdcall, dynlib: "api-ms-win-ro-typeresolution-l1-1-0.dll".}pragma(lib, "api-ms-win-ro-typeresolution-l1-1-0");
extern(Windows)
int RoParseTypeName(
void* typeName, // HSTRING
uint* partsCount, // DWORD* out
void* typeNameParts // HSTRING** out
);ccall((:RoParseTypeName, "api-ms-win-ro-typeresolution-l1-1-0.dll"), stdcall, Int32,
(Ptr{Cvoid}, Ptr{UInt32}, Ptr{Cvoid}),
typeName, partsCount, typeNameParts)
# typeName : HSTRING -> Ptr{Cvoid}
# partsCount : DWORD* out -> Ptr{UInt32}
# typeNameParts : HSTRING** out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t RoParseTypeName(
void* typeName,
uint32_t* partsCount,
void* typeNameParts);
]]
local api-ms-win-ro-typeresolution-l1-1-0 = ffi.load("api-ms-win-ro-typeresolution-l1-1-0")
-- api-ms-win-ro-typeresolution-l1-1-0.RoParseTypeName(typeName, partsCount, typeNameParts)
-- typeName : HSTRING
-- partsCount : DWORD* out
-- typeNameParts : HSTRING** out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('api-ms-win-ro-typeresolution-l1-1-0.dll');
const RoParseTypeName = lib.func('__stdcall', 'RoParseTypeName', 'int32_t', ['void *', 'uint32_t *', 'void *']);
// RoParseTypeName(typeName, partsCount, typeNameParts)
// typeName : HSTRING -> 'void *'
// partsCount : DWORD* out -> 'uint32_t *'
// typeNameParts : HSTRING** out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("api-ms-win-ro-typeresolution-l1-1-0.dll", {
RoParseTypeName: { parameters: ["pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.RoParseTypeName(typeName, partsCount, typeNameParts)
// typeName : HSTRING -> "pointer"
// partsCount : DWORD* out -> "pointer"
// typeNameParts : HSTRING** out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t RoParseTypeName(
void* typeName,
uint32_t* partsCount,
void* typeNameParts);
C, "api-ms-win-ro-typeresolution-l1-1-0.dll");
// $ffi->RoParseTypeName(typeName, partsCount, typeNameParts);
// typeName : HSTRING
// partsCount : DWORD* out
// typeNameParts : HSTRING** out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;
public interface Api-ms-win-ro-typeresolution-l1-1-0 extends StdCallLibrary {
Api-ms-win-ro-typeresolution-l1-1-0 INSTANCE = Native.load("api-ms-win-ro-typeresolution-l1-1-0", Api-ms-win-ro-typeresolution-l1-1-0.class);
int RoParseTypeName(
Pointer typeName, // HSTRING
IntByReference partsCount, // DWORD* out
Pointer typeNameParts // HSTRING** out
);
}@[Link("api-ms-win-ro-typeresolution-l1-1-0")]
lib Libapi-ms-win-ro-typeresolution-l1-1-0
fun RoParseTypeName = RoParseTypeName(
typeName : Void*, # HSTRING
partsCount : UInt32*, # DWORD* out
typeNameParts : Void* # HSTRING** out
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef RoParseTypeNameNative = Int32 Function(Pointer<Void>, Pointer<Uint32>, Pointer<Void>);
typedef RoParseTypeNameDart = int Function(Pointer<Void>, Pointer<Uint32>, Pointer<Void>);
final RoParseTypeName = DynamicLibrary.open('api-ms-win-ro-typeresolution-l1-1-0.dll')
.lookupFunction<RoParseTypeNameNative, RoParseTypeNameDart>('RoParseTypeName');
// typeName : HSTRING -> Pointer<Void>
// partsCount : DWORD* out -> Pointer<Uint32>
// typeNameParts : HSTRING** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function RoParseTypeName(
typeName: THandle; // HSTRING
partsCount: Pointer; // DWORD* out
typeNameParts: Pointer // HSTRING** out
): Integer; stdcall;
external 'api-ms-win-ro-typeresolution-l1-1-0.dll' name 'RoParseTypeName';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "RoParseTypeName"
c_RoParseTypeName :: Ptr () -> Ptr Word32 -> Ptr () -> IO Int32
-- typeName : HSTRING -> Ptr ()
-- partsCount : DWORD* out -> Ptr Word32
-- typeNameParts : HSTRING** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let roparsetypename =
foreign "RoParseTypeName"
((ptr void) @-> (ptr uint32_t) @-> (ptr void) @-> returning int32_t)
(* typeName : HSTRING -> (ptr void) *)
(* partsCount : DWORD* out -> (ptr uint32_t) *)
(* typeNameParts : HSTRING** out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library api-ms-win-ro-typeresolution-l1-1-0 (t "api-ms-win-ro-typeresolution-l1-1-0.dll"))
(cffi:use-foreign-library api-ms-win-ro-typeresolution-l1-1-0)
(cffi:defcfun ("RoParseTypeName" ro-parse-type-name :convention :stdcall) :int32
(type-name :pointer) ; HSTRING
(parts-count :pointer) ; DWORD* out
(type-name-parts :pointer)) ; HSTRING** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $RoParseTypeName = Win32::API::More->new('api-ms-win-ro-typeresolution-l1-1-0',
'int RoParseTypeName(HANDLE typeName, LPVOID partsCount, HANDLE typeNameParts)');
# my $ret = $RoParseTypeName->Call($typeName, $partsCount, $typeNameParts);
# typeName : HSTRING -> HANDLE
# partsCount : DWORD* out -> LPVOID
# typeNameParts : HSTRING** out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。