StringFromGUID2

関数

GUIDを指定バッファに文字列形式で書き込む。

DLLOLE32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

INT StringFromGUID2(
    const GUID* rguid,
    LPWSTR lpsz,
    INT cchMax
);

パラメーター

名前	型	方向	説明
rguid	GUID*	in	変換する GUID。
lpsz	LPWSTR	out	変換結果の文字列を受け取る、呼び出し側が割り当てた文字列変数へのポインター。rguid を表す文字列には、囲みの中かっこが含まれます。
cchMax	INT	in	lpsz バッファーで使用可能な文字数。

戻り値の型: INT

公式ドキュメント

グローバル一意識別子 (GUID) を印刷可能な文字の文字列に変換します。

戻り値

関数が成功した場合、戻り値は返される文字列の文字数 (null 終端文字を含む) です。バッファーが文字列を格納するには小さすぎる場合、戻り値は 0 です。

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

各言語での呼び出し定義

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

INT StringFromGUID2(
    const GUID* rguid,
    LPWSTR lpsz,
    INT cchMax
);

[DllImport("OLE32.dll", ExactSpelling = true)]
static extern int StringFromGUID2(
    ref Guid rguid,   // GUID*
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpsz,   // LPWSTR out
    int cchMax   // INT
);

<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function StringFromGUID2(
    ByRef rguid As Guid,   ' GUID*
    <MarshalAs(UnmanagedType.LPWStr)> lpsz As System.Text.StringBuilder,   ' LPWSTR out
    cchMax As Integer   ' INT
) As Integer
End Function

' rguid : GUID*
' lpsz : LPWSTR out
' cchMax : INT
Declare PtrSafe Function StringFromGUID2 Lib "ole32" ( _
    ByVal rguid As LongPtr, _
    ByVal lpsz As LongPtr, _
    ByVal cchMax As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

StringFromGUID2 = ctypes.windll.ole32.StringFromGUID2
StringFromGUID2.restype = ctypes.c_int
StringFromGUID2.argtypes = [
    ctypes.c_void_p,  # rguid : GUID*
    wintypes.LPWSTR,  # lpsz : LPWSTR out
    ctypes.c_int,  # cchMax : INT
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLE32.dll')
StringFromGUID2 = Fiddle::Function.new(
  lib['StringFromGUID2'],
  [
    Fiddle::TYPE_VOIDP,  # rguid : GUID*
    Fiddle::TYPE_VOIDP,  # lpsz : LPWSTR out
    Fiddle::TYPE_INT,  # cchMax : INT
  ],
  Fiddle::TYPE_INT)

#[link(name = "ole32")]
extern "system" {
    fn StringFromGUID2(
        rguid: *const GUID,  // GUID*
        lpsz: *mut u16,  // LPWSTR out
        cchMax: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("OLE32.dll")]
public static extern int StringFromGUID2(ref Guid rguid, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpsz, int cchMax);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_StringFromGUID2' -Namespace Win32 -PassThru
# $api::StringFromGUID2(rguid, lpsz, cchMax)

#uselib "OLE32.dll"
#func global StringFromGUID2 "StringFromGUID2" sptr, sptr, sptr
; StringFromGUID2 varptr(rguid), varptr(lpsz), cchMax   ; 戻り値は stat
; rguid : GUID* -> "sptr"
; lpsz : LPWSTR out -> "sptr"
; cchMax : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "OLE32.dll"
#cfunc global StringFromGUID2 "StringFromGUID2" var, var, int
; res = StringFromGUID2(rguid, lpsz, cchMax)
; rguid : GUID* -> "var"
; lpsz : LPWSTR out -> "var"
; cchMax : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "OLE32.dll"
#cfunc global StringFromGUID2 "StringFromGUID2" sptr, sptr, int
; res = StringFromGUID2(varptr(rguid), varptr(lpsz), cchMax)
; rguid : GUID* -> "sptr"
; lpsz : LPWSTR out -> "sptr"
; cchMax : INT -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。