Win32 API 日本語リファレンス
ホームSystem.Rpc › NdrClearOutParameters

NdrClearOutParameters

関数
RPCの出力パラメータ領域をゼロクリアする。
DLLRPCRT4.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// RPCRT4.dll
#include <windows.h>

void NdrClearOutParameters(
    MIDL_STUB_MESSAGE* pStubMsg,
    BYTE* pFormat,
    void* ArgAddr
);

パラメーター

名前方向説明
pStubMsgMIDL_STUB_MESSAGE*inoutNDRスタブメッセージへのポインタ。クリア処理の文脈情報を保持する。
pFormatBYTE*inout対象パラメータを記述するNDRフォーマット文字列へのポインタ。
ArgAddrvoid*inoutクリアする[out]パラメータが格納されたメモリのアドレス。

戻り値の型: void

各言語での呼び出し定義

// RPCRT4.dll
#include <windows.h>

void NdrClearOutParameters(
    MIDL_STUB_MESSAGE* pStubMsg,
    BYTE* pFormat,
    void* ArgAddr
);
[DllImport("RPCRT4.dll", ExactSpelling = true)]
static extern void NdrClearOutParameters(
    IntPtr pStubMsg,   // MIDL_STUB_MESSAGE* in/out
    IntPtr pFormat,   // BYTE* in/out
    IntPtr ArgAddr   // void* in/out
);
<DllImport("RPCRT4.dll", ExactSpelling:=True)>
Public Shared Sub NdrClearOutParameters(
    pStubMsg As IntPtr,   ' MIDL_STUB_MESSAGE* in/out
    pFormat As IntPtr,   ' BYTE* in/out
    ArgAddr As IntPtr   ' void* in/out
)
End Sub
' pStubMsg : MIDL_STUB_MESSAGE* in/out
' pFormat : BYTE* in/out
' ArgAddr : void* in/out
Declare PtrSafe Sub NdrClearOutParameters Lib "rpcrt4" ( _
    ByVal pStubMsg As LongPtr, _
    ByVal pFormat As LongPtr, _
    ByVal ArgAddr As LongPtr)
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

NdrClearOutParameters = ctypes.windll.rpcrt4.NdrClearOutParameters
NdrClearOutParameters.restype = None
NdrClearOutParameters.argtypes = [
    ctypes.c_void_p,  # pStubMsg : MIDL_STUB_MESSAGE* in/out
    ctypes.POINTER(ctypes.c_ubyte),  # pFormat : BYTE* in/out
    ctypes.POINTER(None),  # ArgAddr : void* in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('RPCRT4.dll')
NdrClearOutParameters = Fiddle::Function.new(
  lib['NdrClearOutParameters'],
  [
    Fiddle::TYPE_VOIDP,  # pStubMsg : MIDL_STUB_MESSAGE* in/out
    Fiddle::TYPE_VOIDP,  # pFormat : BYTE* in/out
    Fiddle::TYPE_VOIDP,  # ArgAddr : void* in/out
  ],
  Fiddle::TYPE_VOID)
#[link(name = "rpcrt4")]
extern "system" {
    fn NdrClearOutParameters(
        pStubMsg: *mut MIDL_STUB_MESSAGE,  // MIDL_STUB_MESSAGE* in/out
        pFormat: *mut u8,  // BYTE* in/out
        ArgAddr: *mut ()  // void* in/out
    );
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("RPCRT4.dll")]
public static extern void NdrClearOutParameters(IntPtr pStubMsg, IntPtr pFormat, IntPtr ArgAddr);
"@
$api = Add-Type -MemberDefinition $sig -Name 'RPCRT4_NdrClearOutParameters' -Namespace Win32 -PassThru
# $api::NdrClearOutParameters(pStubMsg, pFormat, ArgAddr)
#uselib "RPCRT4.dll"
#func global NdrClearOutParameters "NdrClearOutParameters" sptr, sptr, sptr
; NdrClearOutParameters varptr(pStubMsg), varptr(pFormat), ArgAddr
; pStubMsg : MIDL_STUB_MESSAGE* in/out -> "sptr"
; pFormat : BYTE* in/out -> "sptr"
; ArgAddr : void* in/out -> "sptr"
出力引数:
#uselib "RPCRT4.dll"
#func global NdrClearOutParameters "NdrClearOutParameters" var, var, sptr
; NdrClearOutParameters pStubMsg, pFormat, ArgAddr
; pStubMsg : MIDL_STUB_MESSAGE* in/out -> "var"
; pFormat : BYTE* in/out -> "var"
; ArgAddr : void* in/out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; void NdrClearOutParameters(MIDL_STUB_MESSAGE* pStubMsg, BYTE* pFormat, void* ArgAddr)
#uselib "RPCRT4.dll"
#func global NdrClearOutParameters "NdrClearOutParameters" var, var, intptr
; NdrClearOutParameters pStubMsg, pFormat, ArgAddr
; pStubMsg : MIDL_STUB_MESSAGE* in/out -> "var"
; pFormat : BYTE* in/out -> "var"
; ArgAddr : void* in/out -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	rpcrt4 = windows.NewLazySystemDLL("RPCRT4.dll")
	procNdrClearOutParameters = rpcrt4.NewProc("NdrClearOutParameters")
)

// pStubMsg (MIDL_STUB_MESSAGE* in/out), pFormat (BYTE* in/out), ArgAddr (void* in/out)
r1, _, err := procNdrClearOutParameters.Call(
	uintptr(pStubMsg),
	uintptr(pFormat),
	uintptr(ArgAddr),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // void
procedure NdrClearOutParameters(
  pStubMsg: Pointer;   // MIDL_STUB_MESSAGE* in/out
  pFormat: Pointer;   // BYTE* in/out
  ArgAddr: Pointer   // void* in/out
); stdcall;
  external 'RPCRT4.dll' name 'NdrClearOutParameters';
result := DllCall("RPCRT4\NdrClearOutParameters"
    , "Ptr", pStubMsg   ; MIDL_STUB_MESSAGE* in/out
    , "Ptr", pFormat   ; BYTE* in/out
    , "Ptr", ArgAddr   ; void* in/out
    , "Int")   ; return: void
●NdrClearOutParameters(pStubMsg, pFormat, ArgAddr) = DLL("RPCRT4.dll", "int NdrClearOutParameters(void*, void*, void*)")
# 呼び出し: NdrClearOutParameters(pStubMsg, pFormat, ArgAddr)
# pStubMsg : MIDL_STUB_MESSAGE* in/out -> "void*"
# pFormat : BYTE* in/out -> "void*"
# ArgAddr : void* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "rpcrt4" fn NdrClearOutParameters(
    pStubMsg: [*c]MIDL_STUB_MESSAGE, // MIDL_STUB_MESSAGE* in/out
    pFormat: [*c]u8, // BYTE* in/out
    ArgAddr: ?*anyopaque // void* in/out
) callconv(std.os.windows.WINAPI) void;
proc NdrClearOutParameters(
    pStubMsg: ptr MIDL_STUB_MESSAGE,  # MIDL_STUB_MESSAGE* in/out
    pFormat: ptr uint8,  # BYTE* in/out
    ArgAddr: pointer  # void* in/out
) {.importc: "NdrClearOutParameters", stdcall, dynlib: "RPCRT4.dll".}
pragma(lib, "rpcrt4");
extern(Windows)
void NdrClearOutParameters(
    MIDL_STUB_MESSAGE* pStubMsg,   // MIDL_STUB_MESSAGE* in/out
    ubyte* pFormat,   // BYTE* in/out
    void* ArgAddr   // void* in/out
);
ccall((:NdrClearOutParameters, "RPCRT4.dll"), stdcall, Cvoid,
      (Ptr{MIDL_STUB_MESSAGE}, Ptr{UInt8}, Ptr{Cvoid}),
      pStubMsg, pFormat, ArgAddr)
# pStubMsg : MIDL_STUB_MESSAGE* in/out -> Ptr{MIDL_STUB_MESSAGE}
# pFormat : BYTE* in/out -> Ptr{UInt8}
# ArgAddr : void* in/out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
void NdrClearOutParameters(
    void* pStubMsg,
    uint8_t* pFormat,
    void* ArgAddr);
]]
local rpcrt4 = ffi.load("rpcrt4")
-- rpcrt4.NdrClearOutParameters(pStubMsg, pFormat, ArgAddr)
-- pStubMsg : MIDL_STUB_MESSAGE* in/out
-- pFormat : BYTE* in/out
-- ArgAddr : void* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('RPCRT4.dll');
const NdrClearOutParameters = lib.func('__stdcall', 'NdrClearOutParameters', 'void', ['void *', 'uint8_t *', 'void *']);
// NdrClearOutParameters(pStubMsg, pFormat, ArgAddr)
// pStubMsg : MIDL_STUB_MESSAGE* in/out -> 'void *'
// pFormat : BYTE* in/out -> 'uint8_t *'
// ArgAddr : void* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("RPCRT4.dll", {
  NdrClearOutParameters: { parameters: ["pointer", "pointer", "pointer"], result: "void" },
});
// lib.symbols.NdrClearOutParameters(pStubMsg, pFormat, ArgAddr)
// pStubMsg : MIDL_STUB_MESSAGE* in/out -> "pointer"
// pFormat : BYTE* in/out -> "pointer"
// ArgAddr : void* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void NdrClearOutParameters(
    void* pStubMsg,
    uint8_t* pFormat,
    void* ArgAddr);
C, "RPCRT4.dll");
// $ffi->NdrClearOutParameters(pStubMsg, pFormat, ArgAddr);
// pStubMsg : MIDL_STUB_MESSAGE* in/out
// pFormat : BYTE* in/out
// ArgAddr : void* in/out
// 構造体/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);
    void NdrClearOutParameters(
        Pointer pStubMsg,   // MIDL_STUB_MESSAGE* in/out
        byte[] pFormat,   // BYTE* in/out
        Pointer ArgAddr   // void* in/out
    );
}
@[Link("rpcrt4")]
lib LibRPCRT4
  fun NdrClearOutParameters = NdrClearOutParameters(
    pStubMsg : MIDL_STUB_MESSAGE*,   # MIDL_STUB_MESSAGE* in/out
    pFormat : UInt8*,   # BYTE* in/out
    ArgAddr : Void*   # void* in/out
  ) : Void
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef NdrClearOutParametersNative = Void Function(Pointer<Void>, Pointer<Uint8>, Pointer<Void>);
typedef NdrClearOutParametersDart = void Function(Pointer<Void>, Pointer<Uint8>, Pointer<Void>);
final NdrClearOutParameters = DynamicLibrary.open('RPCRT4.dll')
    .lookupFunction<NdrClearOutParametersNative, NdrClearOutParametersDart>('NdrClearOutParameters');
// pStubMsg : MIDL_STUB_MESSAGE* in/out -> Pointer<Void>
// pFormat : BYTE* in/out -> Pointer<Uint8>
// ArgAddr : void* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
procedure NdrClearOutParameters(
  pStubMsg: Pointer;   // MIDL_STUB_MESSAGE* in/out
  pFormat: Pointer;   // BYTE* in/out
  ArgAddr: Pointer   // void* in/out
); stdcall;
  external 'RPCRT4.dll' name 'NdrClearOutParameters';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "NdrClearOutParameters"
  c_NdrClearOutParameters :: Ptr () -> Ptr Word8 -> Ptr () -> IO ()
-- pStubMsg : MIDL_STUB_MESSAGE* in/out -> Ptr ()
-- pFormat : BYTE* in/out -> Ptr Word8
-- ArgAddr : void* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let ndrclearoutparameters =
  foreign "NdrClearOutParameters"
    ((ptr void) @-> (ptr uint8_t) @-> (ptr void) @-> returning void)
(* pStubMsg : MIDL_STUB_MESSAGE* in/out -> (ptr void) *)
(* pFormat : BYTE* in/out -> (ptr uint8_t) *)
(* ArgAddr : void* in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library rpcrt4 (t "RPCRT4.dll"))
(cffi:use-foreign-library rpcrt4)

(cffi:defcfun ("NdrClearOutParameters" ndr-clear-out-parameters :convention :stdcall) :void
  (p-stub-msg :pointer)   ; MIDL_STUB_MESSAGE* in/out
  (p-format :pointer)   ; BYTE* in/out
  (arg-addr :pointer))   ; void* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $NdrClearOutParameters = Win32::API::More->new('RPCRT4',
    'void NdrClearOutParameters(LPVOID pStubMsg, LPVOID pFormat, LPVOID ArgAddr)');
# my $ret = $NdrClearOutParameters->Call($pStubMsg, $pFormat, $ArgAddr);
# pStubMsg : MIDL_STUB_MESSAGE* in/out -> LPVOID
# pFormat : BYTE* in/out -> LPVOID
# ArgAddr : void* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型