Win32 API 日本語リファレンス
ホームSystem.Com › StringFromCLSID

StringFromCLSID

関数
CLSIDを文字列形式に変換する。
DLLOLE32.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT StringFromCLSID(
    const GUID* rclsid,
    LPWSTR* lplpsz
);

パラメーター

名前方向説明
rclsidGUID*in変換する CLSID。
lplpszLPWSTR*out結果の文字列へのポインターを受け取るポインター変数のアドレス。rclsid を表す文字列には、囲みの中かっこが含まれます。

戻り値の型: HRESULT

公式ドキュメント

CLSID を印字可能な文字の文字列に変換します。異なる CLSID は常に異なる文字列に変換されます。

戻り値

この関数は、標準的な戻り値 E_OUTOFMEMORY および S_OK を返すことがあります。

解説(Remarks)

StringFromCLSID は、StringFromGUID2 関数を呼び出して、グローバル一意識別子 (GUID) を印字可能な文字の文字列に変換します。

呼び出し側は、CoTaskMemFree 関数を呼び出して、文字列用に割り当てられたメモリを解放する責任があります。

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

各言語での呼び出し定義

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

HRESULT StringFromCLSID(
    const GUID* rclsid,
    LPWSTR* lplpsz
);
[DllImport("OLE32.dll", ExactSpelling = true)]
static extern int StringFromCLSID(
    ref Guid rclsid,   // GUID*
    IntPtr lplpsz   // LPWSTR* out
);
<DllImport("OLE32.dll", ExactSpelling:=True)>
Public Shared Function StringFromCLSID(
    ByRef rclsid As Guid,   ' GUID*
    lplpsz As IntPtr   ' LPWSTR* out
) As Integer
End Function
' rclsid : GUID*
' lplpsz : LPWSTR* out
Declare PtrSafe Function StringFromCLSID Lib "ole32" ( _
    ByVal rclsid As LongPtr, _
    ByVal lplpsz As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

StringFromCLSID = ctypes.windll.ole32.StringFromCLSID
StringFromCLSID.restype = ctypes.c_int
StringFromCLSID.argtypes = [
    ctypes.c_void_p,  # rclsid : GUID*
    ctypes.c_void_p,  # lplpsz : LPWSTR* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLE32.dll')
StringFromCLSID = Fiddle::Function.new(
  lib['StringFromCLSID'],
  [
    Fiddle::TYPE_VOIDP,  # rclsid : GUID*
    Fiddle::TYPE_VOIDP,  # lplpsz : LPWSTR* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "ole32")]
extern "system" {
    fn StringFromCLSID(
        rclsid: *const GUID,  // GUID*
        lplpsz: *mut *mut u16  // LPWSTR* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("OLE32.dll")]
public static extern int StringFromCLSID(ref Guid rclsid, IntPtr lplpsz);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLE32_StringFromCLSID' -Namespace Win32 -PassThru
# $api::StringFromCLSID(rclsid, lplpsz)
#uselib "OLE32.dll"
#func global StringFromCLSID "StringFromCLSID" sptr, sptr
; StringFromCLSID varptr(rclsid), varptr(lplpsz)   ; 戻り値は stat
; rclsid : GUID* -> "sptr"
; lplpsz : LPWSTR* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "OLE32.dll"
#cfunc global StringFromCLSID "StringFromCLSID" var, var
; res = StringFromCLSID(rclsid, lplpsz)
; rclsid : GUID* -> "var"
; lplpsz : LPWSTR* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT StringFromCLSID(GUID* rclsid, LPWSTR* lplpsz)
#uselib "OLE32.dll"
#cfunc global StringFromCLSID "StringFromCLSID" var, var
; res = StringFromCLSID(rclsid, lplpsz)
; rclsid : GUID* -> "var"
; lplpsz : LPWSTR* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ole32 = windows.NewLazySystemDLL("OLE32.dll")
	procStringFromCLSID = ole32.NewProc("StringFromCLSID")
)

// rclsid (GUID*), lplpsz (LPWSTR* out)
r1, _, err := procStringFromCLSID.Call(
	uintptr(rclsid),
	uintptr(lplpsz),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function StringFromCLSID(
  rclsid: PGUID;   // GUID*
  lplpsz: PPWideChar   // LPWSTR* out
): Integer; stdcall;
  external 'OLE32.dll' name 'StringFromCLSID';
result := DllCall("OLE32\StringFromCLSID"
    , "Ptr", rclsid   ; GUID*
    , "Ptr", lplpsz   ; LPWSTR* out
    , "Int")   ; return: HRESULT
●StringFromCLSID(rclsid, lplpsz) = DLL("OLE32.dll", "int StringFromCLSID(void*, void*)")
# 呼び出し: StringFromCLSID(rclsid, lplpsz)
# rclsid : GUID* -> "void*"
# lplpsz : LPWSTR* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "ole32" fn StringFromCLSID(
    rclsid: [*c]GUID, // GUID*
    lplpsz: [*c][*c]u16 // LPWSTR* out
) callconv(std.os.windows.WINAPI) i32;
proc StringFromCLSID(
    rclsid: ptr GUID,  # GUID*
    lplpsz: ptr WideCString  # LPWSTR* out
): int32 {.importc: "StringFromCLSID", stdcall, dynlib: "OLE32.dll".}
pragma(lib, "ole32");
extern(Windows)
int StringFromCLSID(
    GUID* rclsid,   // GUID*
    wchar** lplpsz   // LPWSTR* out
);
ccall((:StringFromCLSID, "OLE32.dll"), stdcall, Int32,
      (Ptr{GUID}, Ptr{Ptr{UInt16}}),
      rclsid, lplpsz)
# rclsid : GUID* -> Ptr{GUID}
# lplpsz : LPWSTR* out -> Ptr{Ptr{UInt16}}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t StringFromCLSID(
    void* rclsid,
    uint16_t** lplpsz);
]]
local ole32 = ffi.load("ole32")
-- ole32.StringFromCLSID(rclsid, lplpsz)
-- rclsid : GUID*
-- lplpsz : LPWSTR* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('OLE32.dll');
const StringFromCLSID = lib.func('__stdcall', 'StringFromCLSID', 'int32_t', ['void *', 'void *']);
// StringFromCLSID(rclsid, lplpsz)
// rclsid : GUID* -> 'void *'
// lplpsz : LPWSTR* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("OLE32.dll", {
  StringFromCLSID: { parameters: ["pointer", "pointer"], result: "i32" },
});
// lib.symbols.StringFromCLSID(rclsid, lplpsz)
// rclsid : GUID* -> "pointer"
// lplpsz : LPWSTR* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t StringFromCLSID(
    void* rclsid,
    uint16_t** lplpsz);
C, "OLE32.dll");
// $ffi->StringFromCLSID(rclsid, lplpsz);
// rclsid : GUID*
// lplpsz : LPWSTR* 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 Ole32 extends StdCallLibrary {
    Ole32 INSTANCE = Native.load("ole32", Ole32.class);
    int StringFromCLSID(
        Pointer rclsid,   // GUID*
        PointerByReference lplpsz   // LPWSTR* out
    );
}
@[Link("ole32")]
lib LibOLE32
  fun StringFromCLSID = StringFromCLSID(
    rclsid : GUID*,   # GUID*
    lplpsz : UInt16**   # LPWSTR* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef StringFromCLSIDNative = Int32 Function(Pointer<Void>, Pointer<Pointer<Utf16>>);
typedef StringFromCLSIDDart = int Function(Pointer<Void>, Pointer<Pointer<Utf16>>);
final StringFromCLSID = DynamicLibrary.open('OLE32.dll')
    .lookupFunction<StringFromCLSIDNative, StringFromCLSIDDart>('StringFromCLSID');
// rclsid : GUID* -> Pointer<Void>
// lplpsz : LPWSTR* out -> Pointer<Pointer<Utf16>>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function StringFromCLSID(
  rclsid: PGUID;   // GUID*
  lplpsz: PPWideChar   // LPWSTR* out
): Integer; stdcall;
  external 'OLE32.dll' name 'StringFromCLSID';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "StringFromCLSID"
  c_StringFromCLSID :: Ptr () -> Ptr CWString -> IO Int32
-- rclsid : GUID* -> Ptr ()
-- lplpsz : LPWSTR* out -> Ptr CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let stringfromclsid =
  foreign "StringFromCLSID"
    ((ptr void) @-> (ptr (ptr uint16_t)) @-> returning int32_t)
(* rclsid : GUID* -> (ptr void) *)
(* lplpsz : LPWSTR* out -> (ptr (ptr uint16_t)) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ole32 (t "OLE32.dll"))
(cffi:use-foreign-library ole32)

(cffi:defcfun ("StringFromCLSID" string-from-clsid :convention :stdcall) :int32
  (rclsid :pointer)   ; GUID*
  (lplpsz :pointer))   ; LPWSTR* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $StringFromCLSID = Win32::API::More->new('OLE32',
    'int StringFromCLSID(LPVOID rclsid, LPVOID lplpsz)');
# my $ret = $StringFromCLSID->Call($rclsid, $lplpsz);
# rclsid : GUID* -> LPVOID
# lplpsz : LPWSTR* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目