Win32 API 日本語リファレンス
ホームNetworkManagement.Multicast › McastRequestAddress

McastRequestAddress

関数
MADCAPサーバーからマルチキャストアドレスのリースを要求する。
DLLdhcpcsvc.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD McastRequestAddress(
    WORD AddrFamily,
    MCAST_CLIENT_UID* pRequestID,
    MCAST_SCOPE_CTX* pScopeCtx,
    MCAST_LEASE_REQUEST* pAddrRequest,
    MCAST_LEASE_RESPONSE* pAddrResponse
);

パラメーター

名前方向説明
AddrFamilyWORDin対象アドレスファミリ(AF_INET / AF_INET6)。
pRequestIDMCAST_CLIENT_UID*inout要求元を識別するクライアントID(MCAST_CLIENT_UID)へのポインタ。
pScopeCtxMCAST_SCOPE_CTX*inoutアドレスを要求するマルチキャストスコープのコンテキスト(MCAST_SCOPE_CTX)。
pAddrRequestMCAST_LEASE_REQUEST*inout要求するアドレス数やリース時間を指定するMCAST_LEASE_REQUEST。
pAddrResponseMCAST_LEASE_RESPONSE*inout割り当てられたアドレスとリース情報を受け取るMCAST_LEASE_RESPONSE。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD McastRequestAddress(
    WORD AddrFamily,
    MCAST_CLIENT_UID* pRequestID,
    MCAST_SCOPE_CTX* pScopeCtx,
    MCAST_LEASE_REQUEST* pAddrRequest,
    MCAST_LEASE_RESPONSE* pAddrResponse
);
[DllImport("dhcpcsvc.dll", ExactSpelling = true)]
static extern uint McastRequestAddress(
    ushort AddrFamily,   // WORD
    IntPtr pRequestID,   // MCAST_CLIENT_UID* in/out
    IntPtr pScopeCtx,   // MCAST_SCOPE_CTX* in/out
    IntPtr pAddrRequest,   // MCAST_LEASE_REQUEST* in/out
    IntPtr pAddrResponse   // MCAST_LEASE_RESPONSE* in/out
);
<DllImport("dhcpcsvc.dll", ExactSpelling:=True)>
Public Shared Function McastRequestAddress(
    AddrFamily As UShort,   ' WORD
    pRequestID As IntPtr,   ' MCAST_CLIENT_UID* in/out
    pScopeCtx As IntPtr,   ' MCAST_SCOPE_CTX* in/out
    pAddrRequest As IntPtr,   ' MCAST_LEASE_REQUEST* in/out
    pAddrResponse As IntPtr   ' MCAST_LEASE_RESPONSE* in/out
) As UInteger
End Function
' AddrFamily : WORD
' pRequestID : MCAST_CLIENT_UID* in/out
' pScopeCtx : MCAST_SCOPE_CTX* in/out
' pAddrRequest : MCAST_LEASE_REQUEST* in/out
' pAddrResponse : MCAST_LEASE_RESPONSE* in/out
Declare PtrSafe Function McastRequestAddress Lib "dhcpcsvc" ( _
    ByVal AddrFamily As Integer, _
    ByVal pRequestID As LongPtr, _
    ByVal pScopeCtx As LongPtr, _
    ByVal pAddrRequest As LongPtr, _
    ByVal pAddrResponse As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

McastRequestAddress = ctypes.windll.dhcpcsvc.McastRequestAddress
McastRequestAddress.restype = wintypes.DWORD
McastRequestAddress.argtypes = [
    ctypes.c_ushort,  # AddrFamily : WORD
    ctypes.c_void_p,  # pRequestID : MCAST_CLIENT_UID* in/out
    ctypes.c_void_p,  # pScopeCtx : MCAST_SCOPE_CTX* in/out
    ctypes.c_void_p,  # pAddrRequest : MCAST_LEASE_REQUEST* in/out
    ctypes.c_void_p,  # pAddrResponse : MCAST_LEASE_RESPONSE* in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dhcpcsvc.dll')
McastRequestAddress = Fiddle::Function.new(
  lib['McastRequestAddress'],
  [
    -Fiddle::TYPE_SHORT,  # AddrFamily : WORD
    Fiddle::TYPE_VOIDP,  # pRequestID : MCAST_CLIENT_UID* in/out
    Fiddle::TYPE_VOIDP,  # pScopeCtx : MCAST_SCOPE_CTX* in/out
    Fiddle::TYPE_VOIDP,  # pAddrRequest : MCAST_LEASE_REQUEST* in/out
    Fiddle::TYPE_VOIDP,  # pAddrResponse : MCAST_LEASE_RESPONSE* in/out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "dhcpcsvc")]
extern "system" {
    fn McastRequestAddress(
        AddrFamily: u16,  // WORD
        pRequestID: *mut MCAST_CLIENT_UID,  // MCAST_CLIENT_UID* in/out
        pScopeCtx: *mut MCAST_SCOPE_CTX,  // MCAST_SCOPE_CTX* in/out
        pAddrRequest: *mut MCAST_LEASE_REQUEST,  // MCAST_LEASE_REQUEST* in/out
        pAddrResponse: *mut MCAST_LEASE_RESPONSE  // MCAST_LEASE_RESPONSE* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("dhcpcsvc.dll")]
public static extern uint McastRequestAddress(ushort AddrFamily, IntPtr pRequestID, IntPtr pScopeCtx, IntPtr pAddrRequest, IntPtr pAddrResponse);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dhcpcsvc_McastRequestAddress' -Namespace Win32 -PassThru
# $api::McastRequestAddress(AddrFamily, pRequestID, pScopeCtx, pAddrRequest, pAddrResponse)
#uselib "dhcpcsvc.dll"
#func global McastRequestAddress "McastRequestAddress" sptr, sptr, sptr, sptr, sptr
; McastRequestAddress AddrFamily, varptr(pRequestID), varptr(pScopeCtx), varptr(pAddrRequest), varptr(pAddrResponse)   ; 戻り値は stat
; AddrFamily : WORD -> "sptr"
; pRequestID : MCAST_CLIENT_UID* in/out -> "sptr"
; pScopeCtx : MCAST_SCOPE_CTX* in/out -> "sptr"
; pAddrRequest : MCAST_LEASE_REQUEST* in/out -> "sptr"
; pAddrResponse : MCAST_LEASE_RESPONSE* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "dhcpcsvc.dll"
#cfunc global McastRequestAddress "McastRequestAddress" int, var, var, var, var
; res = McastRequestAddress(AddrFamily, pRequestID, pScopeCtx, pAddrRequest, pAddrResponse)
; AddrFamily : WORD -> "int"
; pRequestID : MCAST_CLIENT_UID* in/out -> "var"
; pScopeCtx : MCAST_SCOPE_CTX* in/out -> "var"
; pAddrRequest : MCAST_LEASE_REQUEST* in/out -> "var"
; pAddrResponse : MCAST_LEASE_RESPONSE* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD McastRequestAddress(WORD AddrFamily, MCAST_CLIENT_UID* pRequestID, MCAST_SCOPE_CTX* pScopeCtx, MCAST_LEASE_REQUEST* pAddrRequest, MCAST_LEASE_RESPONSE* pAddrResponse)
#uselib "dhcpcsvc.dll"
#cfunc global McastRequestAddress "McastRequestAddress" int, var, var, var, var
; res = McastRequestAddress(AddrFamily, pRequestID, pScopeCtx, pAddrRequest, pAddrResponse)
; AddrFamily : WORD -> "int"
; pRequestID : MCAST_CLIENT_UID* in/out -> "var"
; pScopeCtx : MCAST_SCOPE_CTX* in/out -> "var"
; pAddrRequest : MCAST_LEASE_REQUEST* in/out -> "var"
; pAddrResponse : MCAST_LEASE_RESPONSE* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dhcpcsvc = windows.NewLazySystemDLL("dhcpcsvc.dll")
	procMcastRequestAddress = dhcpcsvc.NewProc("McastRequestAddress")
)

// AddrFamily (WORD), pRequestID (MCAST_CLIENT_UID* in/out), pScopeCtx (MCAST_SCOPE_CTX* in/out), pAddrRequest (MCAST_LEASE_REQUEST* in/out), pAddrResponse (MCAST_LEASE_RESPONSE* in/out)
r1, _, err := procMcastRequestAddress.Call(
	uintptr(AddrFamily),
	uintptr(pRequestID),
	uintptr(pScopeCtx),
	uintptr(pAddrRequest),
	uintptr(pAddrResponse),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function McastRequestAddress(
  AddrFamily: Word;   // WORD
  pRequestID: Pointer;   // MCAST_CLIENT_UID* in/out
  pScopeCtx: Pointer;   // MCAST_SCOPE_CTX* in/out
  pAddrRequest: Pointer;   // MCAST_LEASE_REQUEST* in/out
  pAddrResponse: Pointer   // MCAST_LEASE_RESPONSE* in/out
): DWORD; stdcall;
  external 'dhcpcsvc.dll' name 'McastRequestAddress';
result := DllCall("dhcpcsvc\McastRequestAddress"
    , "UShort", AddrFamily   ; WORD
    , "Ptr", pRequestID   ; MCAST_CLIENT_UID* in/out
    , "Ptr", pScopeCtx   ; MCAST_SCOPE_CTX* in/out
    , "Ptr", pAddrRequest   ; MCAST_LEASE_REQUEST* in/out
    , "Ptr", pAddrResponse   ; MCAST_LEASE_RESPONSE* in/out
    , "UInt")   ; return: DWORD
●McastRequestAddress(AddrFamily, pRequestID, pScopeCtx, pAddrRequest, pAddrResponse) = DLL("dhcpcsvc.dll", "dword McastRequestAddress(int, void*, void*, void*, void*)")
# 呼び出し: McastRequestAddress(AddrFamily, pRequestID, pScopeCtx, pAddrRequest, pAddrResponse)
# AddrFamily : WORD -> "int"
# pRequestID : MCAST_CLIENT_UID* in/out -> "void*"
# pScopeCtx : MCAST_SCOPE_CTX* in/out -> "void*"
# pAddrRequest : MCAST_LEASE_REQUEST* in/out -> "void*"
# pAddrResponse : MCAST_LEASE_RESPONSE* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "dhcpcsvc" fn McastRequestAddress(
    AddrFamily: u16, // WORD
    pRequestID: [*c]MCAST_CLIENT_UID, // MCAST_CLIENT_UID* in/out
    pScopeCtx: [*c]MCAST_SCOPE_CTX, // MCAST_SCOPE_CTX* in/out
    pAddrRequest: [*c]MCAST_LEASE_REQUEST, // MCAST_LEASE_REQUEST* in/out
    pAddrResponse: [*c]MCAST_LEASE_RESPONSE // MCAST_LEASE_RESPONSE* in/out
) callconv(std.os.windows.WINAPI) u32;
proc McastRequestAddress(
    AddrFamily: uint16,  # WORD
    pRequestID: ptr MCAST_CLIENT_UID,  # MCAST_CLIENT_UID* in/out
    pScopeCtx: ptr MCAST_SCOPE_CTX,  # MCAST_SCOPE_CTX* in/out
    pAddrRequest: ptr MCAST_LEASE_REQUEST,  # MCAST_LEASE_REQUEST* in/out
    pAddrResponse: ptr MCAST_LEASE_RESPONSE  # MCAST_LEASE_RESPONSE* in/out
): uint32 {.importc: "McastRequestAddress", stdcall, dynlib: "dhcpcsvc.dll".}
pragma(lib, "dhcpcsvc");
extern(Windows)
uint McastRequestAddress(
    ushort AddrFamily,   // WORD
    MCAST_CLIENT_UID* pRequestID,   // MCAST_CLIENT_UID* in/out
    MCAST_SCOPE_CTX* pScopeCtx,   // MCAST_SCOPE_CTX* in/out
    MCAST_LEASE_REQUEST* pAddrRequest,   // MCAST_LEASE_REQUEST* in/out
    MCAST_LEASE_RESPONSE* pAddrResponse   // MCAST_LEASE_RESPONSE* in/out
);
ccall((:McastRequestAddress, "dhcpcsvc.dll"), stdcall, UInt32,
      (UInt16, Ptr{MCAST_CLIENT_UID}, Ptr{MCAST_SCOPE_CTX}, Ptr{MCAST_LEASE_REQUEST}, Ptr{MCAST_LEASE_RESPONSE}),
      AddrFamily, pRequestID, pScopeCtx, pAddrRequest, pAddrResponse)
# AddrFamily : WORD -> UInt16
# pRequestID : MCAST_CLIENT_UID* in/out -> Ptr{MCAST_CLIENT_UID}
# pScopeCtx : MCAST_SCOPE_CTX* in/out -> Ptr{MCAST_SCOPE_CTX}
# pAddrRequest : MCAST_LEASE_REQUEST* in/out -> Ptr{MCAST_LEASE_REQUEST}
# pAddrResponse : MCAST_LEASE_RESPONSE* in/out -> Ptr{MCAST_LEASE_RESPONSE}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t McastRequestAddress(
    uint16_t AddrFamily,
    void* pRequestID,
    void* pScopeCtx,
    void* pAddrRequest,
    void* pAddrResponse);
]]
local dhcpcsvc = ffi.load("dhcpcsvc")
-- dhcpcsvc.McastRequestAddress(AddrFamily, pRequestID, pScopeCtx, pAddrRequest, pAddrResponse)
-- AddrFamily : WORD
-- pRequestID : MCAST_CLIENT_UID* in/out
-- pScopeCtx : MCAST_SCOPE_CTX* in/out
-- pAddrRequest : MCAST_LEASE_REQUEST* in/out
-- pAddrResponse : MCAST_LEASE_RESPONSE* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('dhcpcsvc.dll');
const McastRequestAddress = lib.func('__stdcall', 'McastRequestAddress', 'uint32_t', ['uint16_t', 'void *', 'void *', 'void *', 'void *']);
// McastRequestAddress(AddrFamily, pRequestID, pScopeCtx, pAddrRequest, pAddrResponse)
// AddrFamily : WORD -> 'uint16_t'
// pRequestID : MCAST_CLIENT_UID* in/out -> 'void *'
// pScopeCtx : MCAST_SCOPE_CTX* in/out -> 'void *'
// pAddrRequest : MCAST_LEASE_REQUEST* in/out -> 'void *'
// pAddrResponse : MCAST_LEASE_RESPONSE* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("dhcpcsvc.dll", {
  McastRequestAddress: { parameters: ["u16", "pointer", "pointer", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.McastRequestAddress(AddrFamily, pRequestID, pScopeCtx, pAddrRequest, pAddrResponse)
// AddrFamily : WORD -> "u16"
// pRequestID : MCAST_CLIENT_UID* in/out -> "pointer"
// pScopeCtx : MCAST_SCOPE_CTX* in/out -> "pointer"
// pAddrRequest : MCAST_LEASE_REQUEST* in/out -> "pointer"
// pAddrResponse : MCAST_LEASE_RESPONSE* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t McastRequestAddress(
    uint16_t AddrFamily,
    void* pRequestID,
    void* pScopeCtx,
    void* pAddrRequest,
    void* pAddrResponse);
C, "dhcpcsvc.dll");
// $ffi->McastRequestAddress(AddrFamily, pRequestID, pScopeCtx, pAddrRequest, pAddrResponse);
// AddrFamily : WORD
// pRequestID : MCAST_CLIENT_UID* in/out
// pScopeCtx : MCAST_SCOPE_CTX* in/out
// pAddrRequest : MCAST_LEASE_REQUEST* in/out
// pAddrResponse : MCAST_LEASE_RESPONSE* 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 Dhcpcsvc extends StdCallLibrary {
    Dhcpcsvc INSTANCE = Native.load("dhcpcsvc", Dhcpcsvc.class);
    int McastRequestAddress(
        short AddrFamily,   // WORD
        Pointer pRequestID,   // MCAST_CLIENT_UID* in/out
        Pointer pScopeCtx,   // MCAST_SCOPE_CTX* in/out
        Pointer pAddrRequest,   // MCAST_LEASE_REQUEST* in/out
        Pointer pAddrResponse   // MCAST_LEASE_RESPONSE* in/out
    );
}
@[Link("dhcpcsvc")]
lib Libdhcpcsvc
  fun McastRequestAddress = McastRequestAddress(
    AddrFamily : UInt16,   # WORD
    pRequestID : MCAST_CLIENT_UID*,   # MCAST_CLIENT_UID* in/out
    pScopeCtx : MCAST_SCOPE_CTX*,   # MCAST_SCOPE_CTX* in/out
    pAddrRequest : MCAST_LEASE_REQUEST*,   # MCAST_LEASE_REQUEST* in/out
    pAddrResponse : MCAST_LEASE_RESPONSE*   # MCAST_LEASE_RESPONSE* in/out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef McastRequestAddressNative = Uint32 Function(Uint16, Pointer<Void>, Pointer<Void>, Pointer<Void>, Pointer<Void>);
typedef McastRequestAddressDart = int Function(int, Pointer<Void>, Pointer<Void>, Pointer<Void>, Pointer<Void>);
final McastRequestAddress = DynamicLibrary.open('dhcpcsvc.dll')
    .lookupFunction<McastRequestAddressNative, McastRequestAddressDart>('McastRequestAddress');
// AddrFamily : WORD -> Uint16
// pRequestID : MCAST_CLIENT_UID* in/out -> Pointer<Void>
// pScopeCtx : MCAST_SCOPE_CTX* in/out -> Pointer<Void>
// pAddrRequest : MCAST_LEASE_REQUEST* in/out -> Pointer<Void>
// pAddrResponse : MCAST_LEASE_RESPONSE* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function McastRequestAddress(
  AddrFamily: Word;   // WORD
  pRequestID: Pointer;   // MCAST_CLIENT_UID* in/out
  pScopeCtx: Pointer;   // MCAST_SCOPE_CTX* in/out
  pAddrRequest: Pointer;   // MCAST_LEASE_REQUEST* in/out
  pAddrResponse: Pointer   // MCAST_LEASE_RESPONSE* in/out
): DWORD; stdcall;
  external 'dhcpcsvc.dll' name 'McastRequestAddress';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "McastRequestAddress"
  c_McastRequestAddress :: Word16 -> Ptr () -> Ptr () -> Ptr () -> Ptr () -> IO Word32
-- AddrFamily : WORD -> Word16
-- pRequestID : MCAST_CLIENT_UID* in/out -> Ptr ()
-- pScopeCtx : MCAST_SCOPE_CTX* in/out -> Ptr ()
-- pAddrRequest : MCAST_LEASE_REQUEST* in/out -> Ptr ()
-- pAddrResponse : MCAST_LEASE_RESPONSE* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let mcastrequestaddress =
  foreign "McastRequestAddress"
    (uint16_t @-> (ptr void) @-> (ptr void) @-> (ptr void) @-> (ptr void) @-> returning uint32_t)
(* AddrFamily : WORD -> uint16_t *)
(* pRequestID : MCAST_CLIENT_UID* in/out -> (ptr void) *)
(* pScopeCtx : MCAST_SCOPE_CTX* in/out -> (ptr void) *)
(* pAddrRequest : MCAST_LEASE_REQUEST* in/out -> (ptr void) *)
(* pAddrResponse : MCAST_LEASE_RESPONSE* in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library dhcpcsvc (t "dhcpcsvc.dll"))
(cffi:use-foreign-library dhcpcsvc)

(cffi:defcfun ("McastRequestAddress" mcast-request-address :convention :stdcall) :uint32
  (addr-family :uint16)   ; WORD
  (p-request-id :pointer)   ; MCAST_CLIENT_UID* in/out
  (p-scope-ctx :pointer)   ; MCAST_SCOPE_CTX* in/out
  (p-addr-request :pointer)   ; MCAST_LEASE_REQUEST* in/out
  (p-addr-response :pointer))   ; MCAST_LEASE_RESPONSE* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $McastRequestAddress = Win32::API::More->new('dhcpcsvc',
    'DWORD McastRequestAddress(WORD AddrFamily, LPVOID pRequestID, LPVOID pScopeCtx, LPVOID pAddrRequest, LPVOID pAddrResponse)');
# my $ret = $McastRequestAddress->Call($AddrFamily, $pRequestID, $pScopeCtx, $pAddrRequest, $pAddrResponse);
# AddrFamily : WORD -> WORD
# pRequestID : MCAST_CLIENT_UID* in/out -> LPVOID
# pScopeCtx : MCAST_SCOPE_CTX* in/out -> LPVOID
# pAddrRequest : MCAST_LEASE_REQUEST* in/out -> LPVOID
# pAddrResponse : MCAST_LEASE_RESPONSE* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型