ホーム › System.Rpc › RpcNsBindingLookupBeginW

RpcNsBindingLookupBeginW

関数

ネームサービスからの互換バインディング検索を開始する(Unicode版)。

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

シグネチャ

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

RPC_STATUS RpcNsBindingLookupBeginW(
    DWORD EntryNameSyntax,
    LPWSTR EntryName,   // optional
    void* IfSpec,   // optional
    GUID* ObjUuid,   // optional
    DWORD BindingMaxCount,
    void** LookupContext
);

パラメーター

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

戻り値の型: RPC_STATUS

公式ドキュメント

RpcNsBindingLookupBegin 関数は、インターフェイスとオブジェクトに対する検索コンテキストを作成します。(Unicode)

戻り値

値	意味
RPC_S_OK	呼び出しは成功しました。
RPC_S_INVALID_NAME_SYNTAX	名前の構文が無効です。
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)

RpcNsBindingLookupBegin 関数は、指定されたインターフェイスとオブジェクトを提供するサーバーへの、クライアントと互換性のあるバインディングハンドルを検索するための検索コンテキストを作成します。

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

Windows 2000 以降、RPC 環境はネームサービスデータベースとして Active Directory を使用し、ランタイム環境は次の順序で検索を実行します。

ローカルキャッシュを検索します。
ローカルキャッシュにエントリが見つからない場合は、そのコンピューターの Active Directory を検索します。
ローカルコンピューターにエントリが見つからない場合は、ドメイン内の他のすべての Active Directory サービスにブロードキャスト要求を送信します。
なお、エントリが Active Directory に存在していても、そのエントリに関連付けられた情報がない場合、ランタイム環境はこのブロードキャスト要求を発行しません。

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

メモ

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

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

各言語での呼び出し定義

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

RPC_STATUS RpcNsBindingLookupBeginW(
    DWORD EntryNameSyntax,
    LPWSTR EntryName,   // optional
    void* IfSpec,   // optional
    GUID* ObjUuid,   // optional
    DWORD BindingMaxCount,
    void** LookupContext
);

[DllImport("RPCNS4.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int RpcNsBindingLookupBeginW(
    uint EntryNameSyntax,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string EntryName,   // LPWSTR optional
    IntPtr IfSpec,   // void* optional
    IntPtr ObjUuid,   // GUID* optional
    uint BindingMaxCount,   // DWORD
    IntPtr LookupContext   // void** out
);

<DllImport("RPCNS4.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function RpcNsBindingLookupBeginW(
    EntryNameSyntax As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> EntryName As String,   ' LPWSTR optional
    IfSpec As IntPtr,   ' void* optional
    ObjUuid As IntPtr,   ' GUID* optional
    BindingMaxCount As UInteger,   ' DWORD
    LookupContext As IntPtr   ' void** out
) As Integer
End Function

' EntryNameSyntax : DWORD
' EntryName : LPWSTR optional
' IfSpec : void* optional
' ObjUuid : GUID* optional
' BindingMaxCount : DWORD
' LookupContext : void** out
Declare PtrSafe Function RpcNsBindingLookupBeginW Lib "rpcns4" ( _
    ByVal EntryNameSyntax As Long, _
    ByVal EntryName As LongPtr, _
    ByVal IfSpec As LongPtr, _
    ByVal ObjUuid As LongPtr, _
    ByVal BindingMaxCount As Long, _
    ByVal LookupContext 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

RpcNsBindingLookupBeginW = ctypes.windll.rpcns4.RpcNsBindingLookupBeginW
RpcNsBindingLookupBeginW.restype = ctypes.c_int
RpcNsBindingLookupBeginW.argtypes = [
    wintypes.DWORD,  # EntryNameSyntax : DWORD
    wintypes.LPCWSTR,  # EntryName : LPWSTR optional
    ctypes.POINTER(None),  # IfSpec : void* optional
    ctypes.c_void_p,  # ObjUuid : GUID* optional
    wintypes.DWORD,  # BindingMaxCount : DWORD
    ctypes.c_void_p,  # LookupContext : void** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('RPCNS4.dll')
RpcNsBindingLookupBeginW = Fiddle::Function.new(
  lib['RpcNsBindingLookupBeginW'],
  [
    -Fiddle::TYPE_INT,  # EntryNameSyntax : DWORD
    Fiddle::TYPE_VOIDP,  # EntryName : LPWSTR optional
    Fiddle::TYPE_VOIDP,  # IfSpec : void* optional
    Fiddle::TYPE_VOIDP,  # ObjUuid : GUID* optional
    -Fiddle::TYPE_INT,  # BindingMaxCount : DWORD
    Fiddle::TYPE_VOIDP,  # LookupContext : void** out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

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

$sig = @"
[DllImport("RPCNS4.dll", CharSet = CharSet.Unicode)]
public static extern int RpcNsBindingLookupBeginW(uint EntryNameSyntax, [MarshalAs(UnmanagedType.LPWStr)] string EntryName, IntPtr IfSpec, IntPtr ObjUuid, uint BindingMaxCount, IntPtr LookupContext);
"@
$api = Add-Type -MemberDefinition $sig -Name 'RPCNS4_RpcNsBindingLookupBeginW' -Namespace Win32 -PassThru
# $api::RpcNsBindingLookupBeginW(EntryNameSyntax, EntryName, IfSpec, ObjUuid, BindingMaxCount, LookupContext)

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

出力引数:

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