ホーム › System.Rpc › RpcStringBindingComposeA

RpcStringBindingComposeA

関数

各要素から文字列バインディングを合成する(ANSI版)。

DLLRPCRT4.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// RPCRT4.dll  (ANSI / -A)
#include <windows.h>

RPC_STATUS RpcStringBindingComposeA(
    LPSTR ObjUuid,   // optional
    LPSTR ProtSeq,   // optional
    LPSTR NetworkAddr,   // optional
    LPSTR Endpoint,   // optional
    LPSTR Options,   // optional
    LPSTR* StringBinding   // optional
);

パラメーター

名前	型	方向	説明
ObjUuid	LPSTR	inoptional	オブジェクト UUID の null 終端文字列表現へのポインターです。たとえば、文字列 6B29FC40-CA47-1067-B31D-00DD010662DA は有効な UUID を表します。
ProtSeq	LPSTR	inoptional	プロトコルシーケンスの null 終端文字列表現へのポインターです。Note を参照してください。
NetworkAddr	LPSTR	inoptional	ネットワークアドレスの null 終端文字列表現へのポインターです。ネットワークアドレスの形式は、プロトコルシーケンスに関連付けられています。Note を参照してください。
Endpoint	LPSTR	inoptional	エンドポイントの null 終端文字列表現へのポインターです。エンドポイントの形式と内容は、プロトコルシーケンスに関連付けられています。たとえば、プロトコルシーケンス ncacn_np に関連付けられるエンドポイントは、\pipe\pipename 形式のパイプ名です。Note を参照してください。
Options	LPSTR	inoptional	ネットワークオプションの null 終端文字列表現へのポインターです。オプション文字列は、プロトコルシーケンスに関連付けられています。Note を参照してください。
StringBinding	LPSTR*	outoptional	バインディングハンドルの null 終端文字列表現へのポインターへのポインターを返します。 RpcStringBindingCompose が StringBinding パラメーターを返さないようにするには、NULL 値を指定します。この場合、アプリケーションは RpcStringFree を呼び出しません。Note を参照してください。 Note 詳細については、 String Binding を参照してください。

戻り値の型: RPC_STATUS

公式ドキュメント

RpcStringBindingCompose 関数は、文字列バインディングハンドルを作成します。(RpcStringBindingComposeA)

戻り値

値	意味
RPC_S_OK	呼び出しに成功しました。
RPC_S_INVALID_STRING_UUID	UUID の文字列表現が無効です。

Note 有効なエラーコードの一覧については、 RPC Return Values を参照してください。

解説(Remarks)

アプリケーションは RpcStringBindingCompose ルーチンを呼び出して、オブジェクト UUID、プロトコルシーケンス、ネットワークアドレス、エンドポイント、およびその他のネットワークオプションを、バインディングハンドルの文字列表現に結合します。

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

データを持たない入力文字列には、null のパラメーター値を指定するか、空の文字列 (\0) を指定してください。

C 言語の文字列内でリテラルの円記号 (バックスラッシュ) を使用する場合は、エスケープする必要があります。ncacn_np プロトコルシーケンスにおけるサーバー名の実際の C 文字列は \servername となり、パイプ名の実際の C 文字列は \pipe\pipename となります。

メモ

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

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

各言語での呼び出し定義

// RPCRT4.dll  (ANSI / -A)
#include <windows.h>

RPC_STATUS RpcStringBindingComposeA(
    LPSTR ObjUuid,   // optional
    LPSTR ProtSeq,   // optional
    LPSTR NetworkAddr,   // optional
    LPSTR Endpoint,   // optional
    LPSTR Options,   // optional
    LPSTR* StringBinding   // optional
);

[DllImport("RPCRT4.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int RpcStringBindingComposeA(
    [MarshalAs(UnmanagedType.LPStr)] string ObjUuid,   // LPSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string ProtSeq,   // LPSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string NetworkAddr,   // LPSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string Endpoint,   // LPSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string Options,   // LPSTR optional
    IntPtr StringBinding   // LPSTR* optional, out
);

<DllImport("RPCRT4.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function RpcStringBindingComposeA(
    <MarshalAs(UnmanagedType.LPStr)> ObjUuid As String,   ' LPSTR optional
    <MarshalAs(UnmanagedType.LPStr)> ProtSeq As String,   ' LPSTR optional
    <MarshalAs(UnmanagedType.LPStr)> NetworkAddr As String,   ' LPSTR optional
    <MarshalAs(UnmanagedType.LPStr)> Endpoint As String,   ' LPSTR optional
    <MarshalAs(UnmanagedType.LPStr)> Options As String,   ' LPSTR optional
    StringBinding As IntPtr   ' LPSTR* optional, out
) As Integer
End Function

' ObjUuid : LPSTR optional
' ProtSeq : LPSTR optional
' NetworkAddr : LPSTR optional
' Endpoint : LPSTR optional
' Options : LPSTR optional
' StringBinding : LPSTR* optional, out
Declare PtrSafe Function RpcStringBindingComposeA Lib "rpcrt4" ( _
    ByVal ObjUuid As String, _
    ByVal ProtSeq As String, _
    ByVal NetworkAddr As String, _
    ByVal Endpoint As String, _
    ByVal Options As String, _
    ByVal StringBinding As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

RpcStringBindingComposeA = ctypes.windll.rpcrt4.RpcStringBindingComposeA
RpcStringBindingComposeA.restype = ctypes.c_int
RpcStringBindingComposeA.argtypes = [
    wintypes.LPCSTR,  # ObjUuid : LPSTR optional
    wintypes.LPCSTR,  # ProtSeq : LPSTR optional
    wintypes.LPCSTR,  # NetworkAddr : LPSTR optional
    wintypes.LPCSTR,  # Endpoint : LPSTR optional
    wintypes.LPCSTR,  # Options : LPSTR optional
    ctypes.c_void_p,  # StringBinding : LPSTR* optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('RPCRT4.dll')
RpcStringBindingComposeA = Fiddle::Function.new(
  lib['RpcStringBindingComposeA'],
  [
    Fiddle::TYPE_VOIDP,  # ObjUuid : LPSTR optional
    Fiddle::TYPE_VOIDP,  # ProtSeq : LPSTR optional
    Fiddle::TYPE_VOIDP,  # NetworkAddr : LPSTR optional
    Fiddle::TYPE_VOIDP,  # Endpoint : LPSTR optional
    Fiddle::TYPE_VOIDP,  # Options : LPSTR optional
    Fiddle::TYPE_VOIDP,  # StringBinding : LPSTR* optional, out
  ],
  Fiddle::TYPE_INT)

#[link(name = "rpcrt4")]
extern "system" {
    fn RpcStringBindingComposeA(
        ObjUuid: *mut u8,  // LPSTR optional
        ProtSeq: *mut u8,  // LPSTR optional
        NetworkAddr: *mut u8,  // LPSTR optional
        Endpoint: *mut u8,  // LPSTR optional
        Options: *mut u8,  // LPSTR optional
        StringBinding: *mut *mut u8  // LPSTR* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("RPCRT4.dll", CharSet = CharSet.Ansi)]
public static extern int RpcStringBindingComposeA([MarshalAs(UnmanagedType.LPStr)] string ObjUuid, [MarshalAs(UnmanagedType.LPStr)] string ProtSeq, [MarshalAs(UnmanagedType.LPStr)] string NetworkAddr, [MarshalAs(UnmanagedType.LPStr)] string Endpoint, [MarshalAs(UnmanagedType.LPStr)] string Options, IntPtr StringBinding);
"@
$api = Add-Type -MemberDefinition $sig -Name 'RPCRT4_RpcStringBindingComposeA' -Namespace Win32 -PassThru
# $api::RpcStringBindingComposeA(ObjUuid, ProtSeq, NetworkAddr, Endpoint, Options, StringBinding)

#uselib "RPCRT4.dll"
#func global RpcStringBindingComposeA "RpcStringBindingComposeA" sptr, sptr, sptr, sptr, sptr, sptr
; RpcStringBindingComposeA ObjUuid, ProtSeq, NetworkAddr, Endpoint, Options, varptr(StringBinding)   ; 戻り値は stat
; ObjUuid : LPSTR optional -> "sptr"
; ProtSeq : LPSTR optional -> "sptr"
; NetworkAddr : LPSTR optional -> "sptr"
; Endpoint : LPSTR optional -> "sptr"
; Options : LPSTR optional -> "sptr"
; StringBinding : LPSTR* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "RPCRT4.dll"
#cfunc global RpcStringBindingComposeA "RpcStringBindingComposeA" str, str, str, str, str, var
; res = RpcStringBindingComposeA(ObjUuid, ProtSeq, NetworkAddr, Endpoint, Options, StringBinding)
; ObjUuid : LPSTR optional -> "str"
; ProtSeq : LPSTR optional -> "str"
; NetworkAddr : LPSTR optional -> "str"
; Endpoint : LPSTR optional -> "str"
; Options : LPSTR optional -> "str"
; StringBinding : LPSTR* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "RPCRT4.dll"
#cfunc global RpcStringBindingComposeA "RpcStringBindingComposeA" str, str, str, str, str, sptr
; res = RpcStringBindingComposeA(ObjUuid, ProtSeq, NetworkAddr, Endpoint, Options, varptr(StringBinding))
; ObjUuid : LPSTR optional -> "str"
; ProtSeq : LPSTR optional -> "str"
; NetworkAddr : LPSTR optional -> "str"
; Endpoint : LPSTR optional -> "str"
; Options : LPSTR optional -> "str"
; StringBinding : LPSTR* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。