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

RpcBindingToStringBindingW

関数
バインディングを文字列表現へ変換する(Unicode版)。
DLLRPCRT4.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// RPCRT4.dll  (Unicode / -W)
#include <windows.h>

RPC_STATUS RpcBindingToStringBindingW(
    void* Binding,
    LPWSTR* StringBinding
);

パラメーター

名前方向説明
Bindingvoid*inバインディングハンドルの文字列表現に変換する、クライアントまたはサーバーのバインディングハンドル。
StringBindingLPWSTR*out

Binding パラメーターで指定されたバインディングハンドルの文字列表現へのポインターへのポインターを返します。

RpcBindingToStringBindingStringBinding パラメーターを返さないようにするには、null 値を指定します。この場合、アプリケーションは RpcStringFree 関数を呼び出しません。

戻り値の型: RPC_STATUS

公式ドキュメント

RpcBindingToStringBindingW (Unicode) 関数 (rpcdce.h) は、バインディングハンドルの文字列表現を返します。

戻り値

意味
RPC_S_OK
呼び出しが成功しました。
RPC_S_INVALID_BINDING
バインディングハンドルが無効でした。
注意 有効なエラーコードの一覧については、 RPC Return Values を参照してください。

解説(Remarks)

RpcBindingToStringBinding 関数は、クライアントまたはサーバーのバインディングハンドルをその文字列表現に変換します。

RPC ランタイムライブラリは、StringBinding パラメーターで返される文字列のメモリを割り当てます。そのメモリを解放するために RpcStringFree 関数を呼び出す責任は、アプリケーションにあります。

Binding パラメーターのバインディングハンドルに nil のオブジェクト UUID が含まれていた場合、返される文字列にオブジェクト UUID フィールドは含まれません。

返された StringBinding パラメーターを解析するには、 RpcStringBindingParse 関数を呼び出します。

注意 クライアントのアドレスを照会するには、アプリケーションはまず RpcBindingServerFromClient 関数を呼び出して、部分的にバインドされたサーバーバインディングハンドルを取得します。 このサーバーバインディングハンドルを使用して RpcBindingToStringBinding を呼び出すことで、文字列バインディングを取得できます。 その後、サーバーは RpcStringBindingParse を呼び出して、文字列バインディングからクライアントのネットワークアドレスを抽出できます。
メモ

rpcdce.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして、RpcBindingToStringBinding を定義しています。エンコーディング中立のエイリアスの使用と、エンコーディング中立でないコードを混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因となる場合があります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// RPCRT4.dll  (Unicode / -W)
#include <windows.h>

RPC_STATUS RpcBindingToStringBindingW(
    void* Binding,
    LPWSTR* StringBinding
);
[DllImport("RPCRT4.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int RpcBindingToStringBindingW(
    IntPtr Binding,   // void*
    IntPtr StringBinding   // LPWSTR* out
);
<DllImport("RPCRT4.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function RpcBindingToStringBindingW(
    Binding As IntPtr,   ' void*
    StringBinding As IntPtr   ' LPWSTR* out
) As Integer
End Function
' Binding : void*
' StringBinding : LPWSTR* out
Declare PtrSafe Function RpcBindingToStringBindingW Lib "rpcrt4" ( _
    ByVal Binding As LongPtr, _
    ByVal StringBinding As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

RpcBindingToStringBindingW = ctypes.windll.rpcrt4.RpcBindingToStringBindingW
RpcBindingToStringBindingW.restype = ctypes.c_int
RpcBindingToStringBindingW.argtypes = [
    ctypes.POINTER(None),  # Binding : void*
    ctypes.c_void_p,  # StringBinding : LPWSTR* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('RPCRT4.dll')
RpcBindingToStringBindingW = Fiddle::Function.new(
  lib['RpcBindingToStringBindingW'],
  [
    Fiddle::TYPE_VOIDP,  # Binding : void*
    Fiddle::TYPE_VOIDP,  # StringBinding : LPWSTR* out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "rpcrt4")]
extern "system" {
    fn RpcBindingToStringBindingW(
        Binding: *mut (),  // void*
        StringBinding: *mut *mut u16  // LPWSTR* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("RPCRT4.dll", CharSet = CharSet.Unicode)]
public static extern int RpcBindingToStringBindingW(IntPtr Binding, IntPtr StringBinding);
"@
$api = Add-Type -MemberDefinition $sig -Name 'RPCRT4_RpcBindingToStringBindingW' -Namespace Win32 -PassThru
# $api::RpcBindingToStringBindingW(Binding, StringBinding)
#uselib "RPCRT4.dll"
#func global RpcBindingToStringBindingW "RpcBindingToStringBindingW" wptr, wptr
; RpcBindingToStringBindingW Binding, varptr(StringBinding)   ; 戻り値は stat
; Binding : void* -> "wptr"
; StringBinding : LPWSTR* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "RPCRT4.dll"
#cfunc global RpcBindingToStringBindingW "RpcBindingToStringBindingW" sptr, var
; res = RpcBindingToStringBindingW(Binding, StringBinding)
; Binding : void* -> "sptr"
; StringBinding : LPWSTR* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; RPC_STATUS RpcBindingToStringBindingW(void* Binding, LPWSTR* StringBinding)
#uselib "RPCRT4.dll"
#cfunc global RpcBindingToStringBindingW "RpcBindingToStringBindingW" intptr, var
; res = RpcBindingToStringBindingW(Binding, StringBinding)
; Binding : void* -> "intptr"
; StringBinding : LPWSTR* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	rpcrt4 = windows.NewLazySystemDLL("RPCRT4.dll")
	procRpcBindingToStringBindingW = rpcrt4.NewProc("RpcBindingToStringBindingW")
)

// Binding (void*), StringBinding (LPWSTR* out)
r1, _, err := procRpcBindingToStringBindingW.Call(
	uintptr(Binding),
	uintptr(StringBinding),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // RPC_STATUS
function RpcBindingToStringBindingW(
  Binding: Pointer;   // void*
  StringBinding: PPWideChar   // LPWSTR* out
): Integer; stdcall;
  external 'RPCRT4.dll' name 'RpcBindingToStringBindingW';
result := DllCall("RPCRT4\RpcBindingToStringBindingW"
    , "Ptr", Binding   ; void*
    , "Ptr", StringBinding   ; LPWSTR* out
    , "Int")   ; return: RPC_STATUS
●RpcBindingToStringBindingW(Binding, StringBinding) = DLL("RPCRT4.dll", "int RpcBindingToStringBindingW(void*, void*)")
# 呼び出し: RpcBindingToStringBindingW(Binding, StringBinding)
# Binding : void* -> "void*"
# StringBinding : LPWSTR* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "rpcrt4" fn RpcBindingToStringBindingW(
    Binding: ?*anyopaque, // void*
    StringBinding: [*c][*c]u16 // LPWSTR* out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc RpcBindingToStringBindingW(
    Binding: pointer,  # void*
    StringBinding: ptr WideCString  # LPWSTR* out
): int32 {.importc: "RpcBindingToStringBindingW", stdcall, dynlib: "RPCRT4.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "rpcrt4");
extern(Windows)
int RpcBindingToStringBindingW(
    void* Binding,   // void*
    wchar** StringBinding   // LPWSTR* out
);
ccall((:RpcBindingToStringBindingW, "RPCRT4.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{Ptr{UInt16}}),
      Binding, StringBinding)
# Binding : void* -> Ptr{Cvoid}
# StringBinding : LPWSTR* out -> Ptr{Ptr{UInt16}}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t RpcBindingToStringBindingW(
    void* Binding,
    uint16_t** StringBinding);
]]
local rpcrt4 = ffi.load("rpcrt4")
-- rpcrt4.RpcBindingToStringBindingW(Binding, StringBinding)
-- Binding : void*
-- StringBinding : LPWSTR* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('RPCRT4.dll');
const RpcBindingToStringBindingW = lib.func('__stdcall', 'RpcBindingToStringBindingW', 'int32_t', ['void *', 'void *']);
// RpcBindingToStringBindingW(Binding, StringBinding)
// Binding : void* -> 'void *'
// StringBinding : LPWSTR* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("RPCRT4.dll", {
  RpcBindingToStringBindingW: { parameters: ["pointer", "pointer"], result: "i32" },
});
// lib.symbols.RpcBindingToStringBindingW(Binding, StringBinding)
// Binding : void* -> "pointer"
// StringBinding : LPWSTR* out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t RpcBindingToStringBindingW(
    void* Binding,
    uint16_t** StringBinding);
C, "RPCRT4.dll");
// $ffi->RpcBindingToStringBindingW(Binding, StringBinding);
// Binding : void*
// StringBinding : 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 Rpcrt4 extends StdCallLibrary {
    Rpcrt4 INSTANCE = Native.load("rpcrt4", Rpcrt4.class, W32APIOptions.UNICODE_OPTIONS);
    int RpcBindingToStringBindingW(
        Pointer Binding,   // void*
        PointerByReference StringBinding   // LPWSTR* out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("rpcrt4")]
lib LibRPCRT4
  fun RpcBindingToStringBindingW = RpcBindingToStringBindingW(
    Binding : Void*,   # void*
    StringBinding : 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 RpcBindingToStringBindingWNative = Int32 Function(Pointer<Void>, Pointer<Pointer<Utf16>>);
typedef RpcBindingToStringBindingWDart = int Function(Pointer<Void>, Pointer<Pointer<Utf16>>);
final RpcBindingToStringBindingW = DynamicLibrary.open('RPCRT4.dll')
    .lookupFunction<RpcBindingToStringBindingWNative, RpcBindingToStringBindingWDart>('RpcBindingToStringBindingW');
// Binding : void* -> Pointer<Void>
// StringBinding : LPWSTR* out -> Pointer<Pointer<Utf16>>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RpcBindingToStringBindingW(
  Binding: Pointer;   // void*
  StringBinding: PPWideChar   // LPWSTR* out
): Integer; stdcall;
  external 'RPCRT4.dll' name 'RpcBindingToStringBindingW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let rpcbindingtostringbindingw =
  foreign "RpcBindingToStringBindingW"
    ((ptr void) @-> (ptr (ptr uint16_t)) @-> returning int32_t)
(* Binding : void* -> (ptr void) *)
(* StringBinding : LPWSTR* out -> (ptr (ptr uint16_t)) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library rpcrt4 (t "RPCRT4.dll"))
(cffi:use-foreign-library rpcrt4)

(cffi:defcfun ("RpcBindingToStringBindingW" rpc-binding-to-string-binding-w :convention :stdcall) :int32
  (binding :pointer)   ; void*
  (string-binding :pointer))   ; LPWSTR* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RpcBindingToStringBindingW = Win32::API::More->new('RPCRT4',
    'int RpcBindingToStringBindingW(LPVOID Binding, LPVOID StringBinding)');
# my $ret = $RpcBindingToStringBindingW->Call($Binding, $StringBinding);
# Binding : void* -> LPVOID
# StringBinding : LPWSTR* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
使用する型