RpcSsContextLockExclusive
関数シグネチャ
// RPCRT4.dll
#include <windows.h>
RPC_STATUS RpcSsContextLockExclusive(
void* ServerBindingHandle, // optional
void* UserContext
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| ServerBindingHandle | void* | inoptional | クライアントへのバインディングを表す、サーバー上のバインディングハンドル。サーバーは、このハンドルが示すクライアントを偽装します。0 を指定した場合、サーバーはこのサーバースレッドが処理しているクライアントを偽装します。 |
| UserContext | void* | in | RPC によってマネージャールーチンまたはサーバールーチンに渡されるポインター。「解説」を参照してください。 out 専用のコンテキストハンドルの場合、 RpcSsContextLockExclusive 関数は何も行いません。 |
戻り値の型: RPC_STATUS
公式ドキュメント
RpcSsContextLockExclusive 関数は、アプリケーションがコンテキストハンドルを排他モードで使用し始めることを可能にします。
戻り値
正常に実行された場合は RPC_S_OK を返し、そのスレッドがコンテキストハンドルに排他モードでアクセスできるようになったことを示します。複数のスレッドがコンテキストハンドルに対する排他ロックを試みた場合は ERROR_MORE_WRITES を返します。「解説」を参照してください。
解説(Remarks)
コンテキストハンドルをシリアル化するか非シリアル化するかを変更できることは、実行時に検出した条件に基づいてコンテキストハンドルを閉じるかどうかを判断するアプリケーションにとって有用です。コンテキストハンドルをシリアル化 (排他) から非シリアル化 (共有) に変更するには、 RpcSsContextLockShared 関数を使用します。
UserContext パラメーターについては、マネージャールーチンがコンテキストハンドルへのポインターを受け取る場合、RPC から受け取ったものと同じポインターを RpcSsContextLockExclusive 関数に渡す必要があります。[in] 専用のコンテキストハンドルで一般的なように、マネージャールーチンがコンテキストハンドル自体を受け取る場合は、コンテキストハンドル自体を RpcSsContextLockExclusive 関数に渡す必要があります。次のコード例はこれを示しています。
void _UseShared(
/* [in] */ handle_t Binding,
//...
/* [in] */ TestContextHandleShared *Ctx,
//...
)
{
//...
RpcStatus = RpcSsContextLockExclusive(Binding, Ctx);
//...
}
マネージャールーチンが複数の [in, out] コンテキストハンドルを引数として受け取る場合、RPC はマネージャールーチンにコンテキストハンドル自体ではなく、コンテキストハンドルへのポインターを渡します。このポインターは一意であることが保証されているため、これを RpcSsContextLockExclusive 関数に渡しても曖昧さはありません。ただし、関数が複数の [in] 専用コンテキストハンドルを受け取る場合、RPC はマネージャールーチンにコンテキストハンドル自体を渡します。そのため、コンテキストハンドルは一意ではない可能性があります。この場合、RPC は指定された値を持つ最初のコンテキストハンドルに対してこの関数を実行します。
メソッドは、共有モードのときにコンテキストハンドルを変更しないでください。 RpcSsContextLockExclusive 関数を呼び出しても、指定したコンテキストハンドルに対するリーダーロックは解除されません。これにより、共有モードでコンテキストハンドルを変更しないアプリケーションに対して、コンテキストハンドルが変更されないことが保証されます。2 つのスレッドが同時に RpcSsContextLockExclusive 関数を呼び出して同じコンテキストハンドルの排他ロックを取得しようとした場合、任意に選択された一方のスレッドには RPC_S_OK が返され、もう一方には ERROR_MORE_WRITES が返されます。ERROR_MORE_WRITES が返されたスレッドは排他ロックを取得しますが、戻り時にはコンテキストハンドルに対するリーダーロックを失っています。ERROR_MORE_WRITES を受け取った呼び出し元は、 RpcSsContextLockExclusive 関数から戻った時点でコンテキストハンドルが破棄されている可能性があるため、コンテキストハンドルについて何も想定してはなりません。
非同期呼び出しでは、同じ呼び出しオブジェクトに対して複数のスレッドから同時に RpcSsContextLockExclusive 関数を使用してはなりません。
RpcSsContextLockExclusive 関数はメモリ不足の状況によって失敗する可能性があるため、RPC サーバーはそのようなエラーを処理できるようにしておく必要があります。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// RPCRT4.dll
#include <windows.h>
RPC_STATUS RpcSsContextLockExclusive(
void* ServerBindingHandle, // optional
void* UserContext
);[DllImport("RPCRT4.dll", ExactSpelling = true)]
static extern int RpcSsContextLockExclusive(
IntPtr ServerBindingHandle, // void* optional
IntPtr UserContext // void*
);<DllImport("RPCRT4.dll", ExactSpelling:=True)>
Public Shared Function RpcSsContextLockExclusive(
ServerBindingHandle As IntPtr, ' void* optional
UserContext As IntPtr ' void*
) As Integer
End Function' ServerBindingHandle : void* optional
' UserContext : void*
Declare PtrSafe Function RpcSsContextLockExclusive Lib "rpcrt4" ( _
ByVal ServerBindingHandle As LongPtr, _
ByVal UserContext As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
RpcSsContextLockExclusive = ctypes.windll.rpcrt4.RpcSsContextLockExclusive
RpcSsContextLockExclusive.restype = ctypes.c_int
RpcSsContextLockExclusive.argtypes = [
ctypes.POINTER(None), # ServerBindingHandle : void* optional
ctypes.POINTER(None), # UserContext : void*
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('RPCRT4.dll')
RpcSsContextLockExclusive = Fiddle::Function.new(
lib['RpcSsContextLockExclusive'],
[
Fiddle::TYPE_VOIDP, # ServerBindingHandle : void* optional
Fiddle::TYPE_VOIDP, # UserContext : void*
],
Fiddle::TYPE_INT)#[link(name = "rpcrt4")]
extern "system" {
fn RpcSsContextLockExclusive(
ServerBindingHandle: *mut (), // void* optional
UserContext: *mut () // void*
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("RPCRT4.dll")]
public static extern int RpcSsContextLockExclusive(IntPtr ServerBindingHandle, IntPtr UserContext);
"@
$api = Add-Type -MemberDefinition $sig -Name 'RPCRT4_RpcSsContextLockExclusive' -Namespace Win32 -PassThru
# $api::RpcSsContextLockExclusive(ServerBindingHandle, UserContext)#uselib "RPCRT4.dll"
#func global RpcSsContextLockExclusive "RpcSsContextLockExclusive" sptr, sptr
; RpcSsContextLockExclusive ServerBindingHandle, UserContext ; 戻り値は stat
; ServerBindingHandle : void* optional -> "sptr"
; UserContext : void* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "RPCRT4.dll"
#cfunc global RpcSsContextLockExclusive "RpcSsContextLockExclusive" sptr, sptr
; res = RpcSsContextLockExclusive(ServerBindingHandle, UserContext)
; ServerBindingHandle : void* optional -> "sptr"
; UserContext : void* -> "sptr"; RPC_STATUS RpcSsContextLockExclusive(void* ServerBindingHandle, void* UserContext)
#uselib "RPCRT4.dll"
#cfunc global RpcSsContextLockExclusive "RpcSsContextLockExclusive" intptr, intptr
; res = RpcSsContextLockExclusive(ServerBindingHandle, UserContext)
; ServerBindingHandle : void* optional -> "intptr"
; UserContext : void* -> "intptr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
rpcrt4 = windows.NewLazySystemDLL("RPCRT4.dll")
procRpcSsContextLockExclusive = rpcrt4.NewProc("RpcSsContextLockExclusive")
)
// ServerBindingHandle (void* optional), UserContext (void*)
r1, _, err := procRpcSsContextLockExclusive.Call(
uintptr(ServerBindingHandle),
uintptr(UserContext),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // RPC_STATUSfunction RpcSsContextLockExclusive(
ServerBindingHandle: Pointer; // void* optional
UserContext: Pointer // void*
): Integer; stdcall;
external 'RPCRT4.dll' name 'RpcSsContextLockExclusive';result := DllCall("RPCRT4\RpcSsContextLockExclusive"
, "Ptr", ServerBindingHandle ; void* optional
, "Ptr", UserContext ; void*
, "Int") ; return: RPC_STATUS●RpcSsContextLockExclusive(ServerBindingHandle, UserContext) = DLL("RPCRT4.dll", "int RpcSsContextLockExclusive(void*, void*)")
# 呼び出し: RpcSsContextLockExclusive(ServerBindingHandle, UserContext)
# ServerBindingHandle : void* optional -> "void*"
# UserContext : void* -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "rpcrt4" fn RpcSsContextLockExclusive(
ServerBindingHandle: ?*anyopaque, // void* optional
UserContext: ?*anyopaque // void*
) callconv(std.os.windows.WINAPI) i32;proc RpcSsContextLockExclusive(
ServerBindingHandle: pointer, # void* optional
UserContext: pointer # void*
): int32 {.importc: "RpcSsContextLockExclusive", stdcall, dynlib: "RPCRT4.dll".}pragma(lib, "rpcrt4");
extern(Windows)
int RpcSsContextLockExclusive(
void* ServerBindingHandle, // void* optional
void* UserContext // void*
);ccall((:RpcSsContextLockExclusive, "RPCRT4.dll"), stdcall, Int32,
(Ptr{Cvoid}, Ptr{Cvoid}),
ServerBindingHandle, UserContext)
# ServerBindingHandle : void* optional -> Ptr{Cvoid}
# UserContext : void* -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t RpcSsContextLockExclusive(
void* ServerBindingHandle,
void* UserContext);
]]
local rpcrt4 = ffi.load("rpcrt4")
-- rpcrt4.RpcSsContextLockExclusive(ServerBindingHandle, UserContext)
-- ServerBindingHandle : void* optional
-- UserContext : void*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('RPCRT4.dll');
const RpcSsContextLockExclusive = lib.func('__stdcall', 'RpcSsContextLockExclusive', 'int32_t', ['void *', 'void *']);
// RpcSsContextLockExclusive(ServerBindingHandle, UserContext)
// ServerBindingHandle : void* optional -> 'void *'
// UserContext : void* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("RPCRT4.dll", {
RpcSsContextLockExclusive: { parameters: ["pointer", "pointer"], result: "i32" },
});
// lib.symbols.RpcSsContextLockExclusive(ServerBindingHandle, UserContext)
// ServerBindingHandle : void* optional -> "pointer"
// UserContext : void* -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t RpcSsContextLockExclusive(
void* ServerBindingHandle,
void* UserContext);
C, "RPCRT4.dll");
// $ffi->RpcSsContextLockExclusive(ServerBindingHandle, UserContext);
// ServerBindingHandle : void* optional
// UserContext : void*
// 構造体/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);
int RpcSsContextLockExclusive(
Pointer ServerBindingHandle, // void* optional
Pointer UserContext // void*
);
}@[Link("rpcrt4")]
lib LibRPCRT4
fun RpcSsContextLockExclusive = RpcSsContextLockExclusive(
ServerBindingHandle : Void*, # void* optional
UserContext : Void* # void*
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef RpcSsContextLockExclusiveNative = Int32 Function(Pointer<Void>, Pointer<Void>);
typedef RpcSsContextLockExclusiveDart = int Function(Pointer<Void>, Pointer<Void>);
final RpcSsContextLockExclusive = DynamicLibrary.open('RPCRT4.dll')
.lookupFunction<RpcSsContextLockExclusiveNative, RpcSsContextLockExclusiveDart>('RpcSsContextLockExclusive');
// ServerBindingHandle : void* optional -> Pointer<Void>
// UserContext : void* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function RpcSsContextLockExclusive(
ServerBindingHandle: Pointer; // void* optional
UserContext: Pointer // void*
): Integer; stdcall;
external 'RPCRT4.dll' name 'RpcSsContextLockExclusive';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "RpcSsContextLockExclusive"
c_RpcSsContextLockExclusive :: Ptr () -> Ptr () -> IO Int32
-- ServerBindingHandle : void* optional -> Ptr ()
-- UserContext : void* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let rpcsscontextlockexclusive =
foreign "RpcSsContextLockExclusive"
((ptr void) @-> (ptr void) @-> returning int32_t)
(* ServerBindingHandle : void* optional -> (ptr void) *)
(* UserContext : void* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library rpcrt4 (t "RPCRT4.dll"))
(cffi:use-foreign-library rpcrt4)
(cffi:defcfun ("RpcSsContextLockExclusive" rpc-ss-context-lock-exclusive :convention :stdcall) :int32
(server-binding-handle :pointer) ; void* optional
(user-context :pointer)) ; void*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $RpcSsContextLockExclusive = Win32::API::More->new('RPCRT4',
'int RpcSsContextLockExclusive(LPVOID ServerBindingHandle, LPVOID UserContext)');
# my $ret = $RpcSsContextLockExclusive->Call($ServerBindingHandle, $UserContext);
# ServerBindingHandle : void* optional -> LPVOID
# UserContext : void* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f RpcSsContextLockShared — コンテキストハンドルを共有ロックする。