ホーム › System.Rpc › RpcBindingInqAuthClientW

RpcBindingInqAuthClientW

関数

クライアント呼び出しの認証情報を取得する(Unicode版)。

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

シグネチャ

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

RPC_STATUS RpcBindingInqAuthClientW(
    void* ClientBinding,   // optional
    void** Privs,
    LPWSTR* ServerPrincName,   // optional
    DWORD* AuthnLevel,   // optional
    DWORD* AuthnSvc,   // optional
    DWORD* AuthzSvc   // optional
);

パラメーター

名前	型	方向	説明
ClientBinding	void*	inoptional	リモートプロシージャコールを行ったクライアントのクライアントバインディングハンドル。この値は 0 でもかまいません。「解説」を参照してください。
Privs	void**	out	ClientBinding バインディングハンドルでリモートプロシージャコールを行ったクライアントアプリケーションの特権情報へのハンドルを指すポインターを返します。ncalrpc の呼び出しの場合、Privs にはクライアントのプリンシパル名を含む文字列が格納されます。このパラメーターが参照するデータは読み取り専用であり、サーバーアプリケーションが変更してはいけません。返されたデータを保持したい場合、サーバーはそのデータをサーバー側で割り当てたメモリにコピーする必要があります。 Privs パラメーターが指すデータは SSP から直接提供されます。そのため、データの形式は SSP に固有です。SSP の詳細については、 Security Support Providers (SSPs) を参照してください。
ServerPrincName	LPWSTR*	outoptional	RpcServerRegisterAuthInfo 関数を呼び出したサーバーアプリケーションが指定したサーバープリンシパル名へのポインターを指すポインターを返します。返される名前の内容とその構文は、使用されている認証サービスによって定義されます。SCHANNEL SSP の場合、プリンシパル名は Microsoft 標準 (msstd) 形式です。msstd 形式の詳細については、 Principal Names を参照してください。 RpcBindingInqAuthClient が ServerPrincName パラメーターを返さないようにするには、null 値を指定します。この場合、アプリケーションは RpcStringFree 関数を呼び出しません。
AuthnLevel	DWORD*	outoptional	ClientBinding バインディングハンドルでリモートプロシージャコールを行ったクライアントアプリケーションが要求した認証レベルが設定されたポインターを返します。 RpcBindingInqAuthClient が AuthnLevel パラメーターを返さないようにするには、null 値を指定します。
AuthnSvc	DWORD*	outoptional	ClientBinding バインディングハンドルでリモートプロシージャコールを行ったクライアントアプリケーションが要求した認証サービスが設定されたポインターを返します。RPC でサポートされる認証レベルの一覧については、 Authentication-Level Constants を参照してください。 RpcBindingInqAuthClient が AuthnSvc パラメーターを返さないようにするには、null 値を指定します。
AuthzSvc	DWORD*	outoptional	ClientBinding バインディングハンドルでリモートプロシージャコールを行ったクライアントアプリケーションが要求した承認サービスが設定されたポインターを返します。 RpcBindingInqAuthClient が AuthzSvc パラメーターを返さないようにするには、null 値を指定します。このパラメーターは RPC_C_AUTHN_WINNT 認証サービスでは使用されません。返される値は常に RPC_C_AUTHZ_NONE になります。

戻り値の型: RPC_STATUS

公式ドキュメント

RpcBindingInqAuthClientW (Unicode) 関数 (rpcdce.h) は、リモートプロシージャコールを行ったクライアントのプリンシパル名または特権属性を取得します。

戻り値

値	意味
RPC_S_OK	呼び出しに成功しました。
RPC_S_INVALID_BINDING	バインディングハンドルが無効でした。
RPC_S_WRONG_KIND_OF_BINDING	この操作に対して不適切な種類のバインディングでした。
RPC_S_BINDING_HAS_NO_AUTH	バインディングに認証情報がありません。

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

解説(Remarks)

サーバーアプリケーションは、リモートプロシージャコールを行った認証済みクライアントのプリンシパル名または特権属性を取得するために RpcBindingInqAuthClient 関数を呼び出します。さらに RpcBindingInqAuthClient は、クライアントが指定した認証サービス、認証レベル、およびサーバープリンシパル名を返します。サーバーは、返されたデータを承認の目的で使用できます。

RPC ランタイムライブラリは、返される ServerPrincName パラメーター用のメモリを割り当てます。アプリケーションは、返された引数の文字列に対して RpcStringFree 関数を呼び出す責任があります。

同期 RPC 呼び出しの場合、サーバーアプリケーションは ClientBinding パラメーターの値として 0 を使用できます。0 を使用すると、現在実行中のリモートプロシージャコールから認証情報および承認情報が取得されます。

メモ

rpcdce.h ヘッダーは、UNICODE プリプロセッサ定数の定義に応じて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして RpcBindingInqAuthClient を定義しています。エンコードに依存しないエイリアスの使用と、エンコードに依存するコードを混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因となることがあります。詳細については、「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 RpcBindingInqAuthClientW(
    void* ClientBinding,   // optional
    void** Privs,
    LPWSTR* ServerPrincName,   // optional
    DWORD* AuthnLevel,   // optional
    DWORD* AuthnSvc,   // optional
    DWORD* AuthzSvc   // optional
);

[DllImport("RPCRT4.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int RpcBindingInqAuthClientW(
    IntPtr ClientBinding,   // void* optional
    IntPtr Privs,   // void** out
    IntPtr ServerPrincName,   // LPWSTR* optional, out
    IntPtr AuthnLevel,   // DWORD* optional, out
    IntPtr AuthnSvc,   // DWORD* optional, out
    IntPtr AuthzSvc   // DWORD* optional, out
);

<DllImport("RPCRT4.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function RpcBindingInqAuthClientW(
    ClientBinding As IntPtr,   ' void* optional
    Privs As IntPtr,   ' void** out
    ServerPrincName As IntPtr,   ' LPWSTR* optional, out
    AuthnLevel As IntPtr,   ' DWORD* optional, out
    AuthnSvc As IntPtr,   ' DWORD* optional, out
    AuthzSvc As IntPtr   ' DWORD* optional, out
) As Integer
End Function

' ClientBinding : void* optional
' Privs : void** out
' ServerPrincName : LPWSTR* optional, out
' AuthnLevel : DWORD* optional, out
' AuthnSvc : DWORD* optional, out
' AuthzSvc : DWORD* optional, out
Declare PtrSafe Function RpcBindingInqAuthClientW Lib "rpcrt4" ( _
    ByVal ClientBinding As LongPtr, _
    ByVal Privs As LongPtr, _
    ByVal ServerPrincName As LongPtr, _
    ByVal AuthnLevel As LongPtr, _
    ByVal AuthnSvc As LongPtr, _
    ByVal AuthzSvc 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

RpcBindingInqAuthClientW = ctypes.windll.rpcrt4.RpcBindingInqAuthClientW
RpcBindingInqAuthClientW.restype = ctypes.c_int
RpcBindingInqAuthClientW.argtypes = [
    ctypes.POINTER(None),  # ClientBinding : void* optional
    ctypes.c_void_p,  # Privs : void** out
    ctypes.c_void_p,  # ServerPrincName : LPWSTR* optional, out
    ctypes.POINTER(wintypes.DWORD),  # AuthnLevel : DWORD* optional, out
    ctypes.POINTER(wintypes.DWORD),  # AuthnSvc : DWORD* optional, out
    ctypes.POINTER(wintypes.DWORD),  # AuthzSvc : DWORD* optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('RPCRT4.dll')
RpcBindingInqAuthClientW = Fiddle::Function.new(
  lib['RpcBindingInqAuthClientW'],
  [
    Fiddle::TYPE_VOIDP,  # ClientBinding : void* optional
    Fiddle::TYPE_VOIDP,  # Privs : void** out
    Fiddle::TYPE_VOIDP,  # ServerPrincName : LPWSTR* optional, out
    Fiddle::TYPE_VOIDP,  # AuthnLevel : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # AuthnSvc : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # AuthzSvc : DWORD* optional, out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "rpcrt4")]
extern "system" {
    fn RpcBindingInqAuthClientW(
        ClientBinding: *mut (),  // void* optional
        Privs: *mut *mut (),  // void** out
        ServerPrincName: *mut *mut u16,  // LPWSTR* optional, out
        AuthnLevel: *mut u32,  // DWORD* optional, out
        AuthnSvc: *mut u32,  // DWORD* optional, out
        AuthzSvc: *mut u32  // DWORD* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("RPCRT4.dll", CharSet = CharSet.Unicode)]
public static extern int RpcBindingInqAuthClientW(IntPtr ClientBinding, IntPtr Privs, IntPtr ServerPrincName, IntPtr AuthnLevel, IntPtr AuthnSvc, IntPtr AuthzSvc);
"@
$api = Add-Type -MemberDefinition $sig -Name 'RPCRT4_RpcBindingInqAuthClientW' -Namespace Win32 -PassThru
# $api::RpcBindingInqAuthClientW(ClientBinding, Privs, ServerPrincName, AuthnLevel, AuthnSvc, AuthzSvc)

#uselib "RPCRT4.dll"
#func global RpcBindingInqAuthClientW "RpcBindingInqAuthClientW" wptr, wptr, wptr, wptr, wptr, wptr
; RpcBindingInqAuthClientW ClientBinding, Privs, varptr(ServerPrincName), varptr(AuthnLevel), varptr(AuthnSvc), varptr(AuthzSvc)   ; 戻り値は stat
; ClientBinding : void* optional -> "wptr"
; Privs : void** out -> "wptr"
; ServerPrincName : LPWSTR* optional, out -> "wptr"
; AuthnLevel : DWORD* optional, out -> "wptr"
; AuthnSvc : DWORD* optional, out -> "wptr"
; AuthzSvc : DWORD* optional, out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "RPCRT4.dll"
#cfunc global RpcBindingInqAuthClientW "RpcBindingInqAuthClientW" sptr, sptr, var, var, var, var
; res = RpcBindingInqAuthClientW(ClientBinding, Privs, ServerPrincName, AuthnLevel, AuthnSvc, AuthzSvc)
; ClientBinding : void* optional -> "sptr"
; Privs : void** out -> "sptr"
; ServerPrincName : LPWSTR* optional, out -> "var"
; AuthnLevel : DWORD* optional, out -> "var"
; AuthnSvc : DWORD* optional, out -> "var"
; AuthzSvc : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "RPCRT4.dll"
#cfunc global RpcBindingInqAuthClientW "RpcBindingInqAuthClientW" sptr, sptr, sptr, sptr, sptr, sptr
; res = RpcBindingInqAuthClientW(ClientBinding, Privs, varptr(ServerPrincName), varptr(AuthnLevel), varptr(AuthnSvc), varptr(AuthzSvc))
; ClientBinding : void* optional -> "sptr"
; Privs : void** out -> "sptr"
; ServerPrincName : LPWSTR* optional, out -> "sptr"
; AuthnLevel : DWORD* optional, out -> "sptr"
; AuthnSvc : DWORD* optional, out -> "sptr"
; AuthzSvc : DWORD* optional, out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。