ホーム › System.Rpc › RpcNsBindingImportBeginA

RpcNsBindingImportBeginA

関数

名前サービスからのバインディングハンドルのインポートを開始する(ANSI版)。

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

シグネチャ

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

RPC_STATUS RpcNsBindingImportBeginA(
    DWORD EntryNameSyntax,
    LPSTR EntryName,   // optional
    void* IfSpec,   // optional
    GUID* ObjUuid,   // optional
    void** ImportContext
);

パラメーター

名前	型	方向	説明
EntryNameSyntax	DWORD	in	EntryName の構文。レジストリの値エントリ HKEY_LOCAL_MACHINE\Software\Microsoft\Rpc\NameService\DefaultSyntax で指定された構文を使用するには、RPC_C_NS_SYNTAX_DEFAULT を指定します。
EntryName	LPSTR	inoptional	互換性のあるバインディングハンドルの検索を開始するエントリ名へのポインター。レジストリの値エントリ HKEY_LOCAL_MACHINE\Software\Microsoft\Rpc\NameService\DefaultEntry で指定されたエントリ名を使用するには、null ポインターまたは空の文字列を指定します。この場合、EntryNameSyntax パラメーターは無視され、ランタイムライブラリは既定の構文を使用します。
IfSpec	void*	inoptional	インポートするインターフェイスを示す、スタブが生成したデータ構造体。インターフェイス仕様がエクスポートされていない場合、または呼び出し元にとって重要でない場合は、このパラメーターに null 値を指定します。この場合、返されるバインディングについては、互換性のあるサポートされたプロトコルシーケンスであることと、指定されたオブジェクト UUID を含むことのみが保証されます。接続先のサーバーが目的のインターフェイスをサポートしていない可能性があります。
ObjUuid	GUID*	inoptional	省略可能なオブジェクト UUID へのポインター。 0 以外の UUID の場合、サーバーが指定されたオブジェクト UUID をエクスポートしているときにのみ、エントリから互換性のあるバインディングハンドルが返されます。 ObjUuid が null ポインターまたは nil UUID の場合、返されるバインディングハンドルには、互換性のあるサーバーがエクスポートしたオブジェクト UUID のいずれかが含まれます。サーバーがオブジェクト UUID を 1 つもエクスポートしていない場合、返される互換性のあるバインディングハンドルには nil オブジェクト UUID が含まれます。
ImportContext	void**	out	RpcNsBindingImportNext 関数および RpcNsBindingImportDone 関数で使用するために返される、ネームサービスハンドル。

戻り値の型: RPC_STATUS

公式ドキュメント

RpcNsBindingImportBegin 関数は、指定されたインターフェイスとオブジェクトを提供するサーバーについて、クライアントと互換性のあるバインディングハンドルをインポートするためのインポートコンテキストを作成します。(ANSI)

戻り値

値	意味
RPC_S_OK	呼び出しに成功しました。
RPC_S_INVALID_NAME_SYNTAX	名前の構文が無効です。
RPC_S_NAME_SERVICE_UNAVAILABLE	名前が最大長を超えています。
RPC_S_UNSUPPORTED_NAME_SYNTAX	名前の構文がサポートされていません。
RPC_S_INCOMPLETE_NAME	名前が不完全です。
RPC_S_ENTRY_NOT_FOUND	ネームサービスのエントリが見つかりませんでした。
RPC_S_NAME_SERVICE_UNAVAILABLE	ネームサービスを利用できません。
RPC_S_INVALID_OBJECT	オブジェクトが無効です。

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

解説(Remarks)

RpcNsBindingImportNext 関数を呼び出す前に、クライアントアプリケーションはまず RpcNsBindingImportBegin を呼び出してインポートコンテキストを作成する必要があります。この関数のパラメーターによって、 RpcNsBindingImportNext 関数の動作が制御されます。

バインディングハンドルのインポートが完了したら、クライアントアプリケーションは RpcNsBindingImportDone 関数を呼び出してインポートコンテキストを削除します。

メモ

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

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

各言語での呼び出し定義

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

RPC_STATUS RpcNsBindingImportBeginA(
    DWORD EntryNameSyntax,
    LPSTR EntryName,   // optional
    void* IfSpec,   // optional
    GUID* ObjUuid,   // optional
    void** ImportContext
);

[DllImport("RPCNS4.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int RpcNsBindingImportBeginA(
    uint EntryNameSyntax,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] string EntryName,   // LPSTR optional
    IntPtr IfSpec,   // void* optional
    IntPtr ObjUuid,   // GUID* optional
    IntPtr ImportContext   // void** out
);

<DllImport("RPCNS4.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function RpcNsBindingImportBeginA(
    EntryNameSyntax As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> EntryName As String,   ' LPSTR optional
    IfSpec As IntPtr,   ' void* optional
    ObjUuid As IntPtr,   ' GUID* optional
    ImportContext As IntPtr   ' void** out
) As Integer
End Function

' EntryNameSyntax : DWORD
' EntryName : LPSTR optional
' IfSpec : void* optional
' ObjUuid : GUID* optional
' ImportContext : void** out
Declare PtrSafe Function RpcNsBindingImportBeginA Lib "rpcns4" ( _
    ByVal EntryNameSyntax As Long, _
    ByVal EntryName As String, _
    ByVal IfSpec As LongPtr, _
    ByVal ObjUuid As LongPtr, _
    ByVal ImportContext As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

RpcNsBindingImportBeginA = ctypes.windll.rpcns4.RpcNsBindingImportBeginA
RpcNsBindingImportBeginA.restype = ctypes.c_int
RpcNsBindingImportBeginA.argtypes = [
    wintypes.DWORD,  # EntryNameSyntax : DWORD
    wintypes.LPCSTR,  # EntryName : LPSTR optional
    ctypes.POINTER(None),  # IfSpec : void* optional
    ctypes.c_void_p,  # ObjUuid : GUID* optional
    ctypes.c_void_p,  # ImportContext : void** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('RPCNS4.dll')
RpcNsBindingImportBeginA = Fiddle::Function.new(
  lib['RpcNsBindingImportBeginA'],
  [
    -Fiddle::TYPE_INT,  # EntryNameSyntax : DWORD
    Fiddle::TYPE_VOIDP,  # EntryName : LPSTR optional
    Fiddle::TYPE_VOIDP,  # IfSpec : void* optional
    Fiddle::TYPE_VOIDP,  # ObjUuid : GUID* optional
    Fiddle::TYPE_VOIDP,  # ImportContext : void** out
  ],
  Fiddle::TYPE_INT)

#[link(name = "rpcns4")]
extern "system" {
    fn RpcNsBindingImportBeginA(
        EntryNameSyntax: u32,  // DWORD
        EntryName: *mut u8,  // LPSTR optional
        IfSpec: *mut (),  // void* optional
        ObjUuid: *mut GUID,  // GUID* optional
        ImportContext: *mut *mut ()  // void** out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("RPCNS4.dll", CharSet = CharSet.Ansi)]
public static extern int RpcNsBindingImportBeginA(uint EntryNameSyntax, [MarshalAs(UnmanagedType.LPStr)] string EntryName, IntPtr IfSpec, IntPtr ObjUuid, IntPtr ImportContext);
"@
$api = Add-Type -MemberDefinition $sig -Name 'RPCNS4_RpcNsBindingImportBeginA' -Namespace Win32 -PassThru
# $api::RpcNsBindingImportBeginA(EntryNameSyntax, EntryName, IfSpec, ObjUuid, ImportContext)

#uselib "RPCNS4.dll"
#func global RpcNsBindingImportBeginA "RpcNsBindingImportBeginA" sptr, sptr, sptr, sptr, sptr
; RpcNsBindingImportBeginA EntryNameSyntax, EntryName, IfSpec, varptr(ObjUuid), ImportContext   ; 戻り値は stat
; EntryNameSyntax : DWORD -> "sptr"
; EntryName : LPSTR optional -> "sptr"
; IfSpec : void* optional -> "sptr"
; ObjUuid : GUID* optional -> "sptr"
; ImportContext : void** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "RPCNS4.dll"
#cfunc global RpcNsBindingImportBeginA "RpcNsBindingImportBeginA" int, str, sptr, var, sptr
; res = RpcNsBindingImportBeginA(EntryNameSyntax, EntryName, IfSpec, ObjUuid, ImportContext)
; EntryNameSyntax : DWORD -> "int"
; EntryName : LPSTR optional -> "str"
; IfSpec : void* optional -> "sptr"
; ObjUuid : GUID* optional -> "var"
; ImportContext : void** out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "RPCNS4.dll"
#cfunc global RpcNsBindingImportBeginA "RpcNsBindingImportBeginA" int, str, sptr, sptr, sptr
; res = RpcNsBindingImportBeginA(EntryNameSyntax, EntryName, IfSpec, varptr(ObjUuid), ImportContext)
; EntryNameSyntax : DWORD -> "int"
; EntryName : LPSTR optional -> "str"
; IfSpec : void* optional -> "sptr"
; ObjUuid : GUID* optional -> "sptr"
; ImportContext : void** out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。