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

GetMailslotInfo

関数
メールスロットの構成情報を取得する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL GetMailslotInfo(
    HANDLE hMailslot,
    DWORD* lpMaxMessageSize,   // optional
    DWORD* lpNextSize,   // optional
    DWORD* lpMessageCount,   // optional
    DWORD* lpReadTimeout   // optional
);

パラメーター

名前方向説明
hMailslotHANDLEin情報を取得するメールスロットのハンドル。
lpMaxMessageSizeDWORD*outoptional1メッセージの最大バイト数を受け取る変数へのポインタ。
lpNextSizeDWORD*outoptional次に読み取れるメッセージのサイズを受け取るポインタ。なければMAILSLOT_NO_MESSAGE。
lpMessageCountDWORD*outoptional未読メッセージ数を受け取る変数へのポインタ。
lpReadTimeoutDWORD*outoptional現在の読み取りタイムアウト値をミリ秒で受け取るポインタ。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL GetMailslotInfo(
    HANDLE hMailslot,
    DWORD* lpMaxMessageSize,   // optional
    DWORD* lpNextSize,   // optional
    DWORD* lpMessageCount,   // optional
    DWORD* lpReadTimeout   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetMailslotInfo(
    IntPtr hMailslot,   // HANDLE
    IntPtr lpMaxMessageSize,   // DWORD* optional, out
    IntPtr lpNextSize,   // DWORD* optional, out
    IntPtr lpMessageCount,   // DWORD* optional, out
    IntPtr lpReadTimeout   // DWORD* optional, out
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetMailslotInfo(
    hMailslot As IntPtr,   ' HANDLE
    lpMaxMessageSize As IntPtr,   ' DWORD* optional, out
    lpNextSize As IntPtr,   ' DWORD* optional, out
    lpMessageCount As IntPtr,   ' DWORD* optional, out
    lpReadTimeout As IntPtr   ' DWORD* optional, out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hMailslot : HANDLE
' lpMaxMessageSize : DWORD* optional, out
' lpNextSize : DWORD* optional, out
' lpMessageCount : DWORD* optional, out
' lpReadTimeout : DWORD* optional, out
Declare PtrSafe Function GetMailslotInfo Lib "kernel32" ( _
    ByVal hMailslot As LongPtr, _
    ByVal lpMaxMessageSize As LongPtr, _
    ByVal lpNextSize As LongPtr, _
    ByVal lpMessageCount As LongPtr, _
    ByVal lpReadTimeout As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetMailslotInfo = ctypes.windll.kernel32.GetMailslotInfo
GetMailslotInfo.restype = wintypes.BOOL
GetMailslotInfo.argtypes = [
    wintypes.HANDLE,  # hMailslot : HANDLE
    ctypes.POINTER(wintypes.DWORD),  # lpMaxMessageSize : DWORD* optional, out
    ctypes.POINTER(wintypes.DWORD),  # lpNextSize : DWORD* optional, out
    ctypes.POINTER(wintypes.DWORD),  # lpMessageCount : DWORD* optional, out
    ctypes.POINTER(wintypes.DWORD),  # lpReadTimeout : DWORD* optional, out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
GetMailslotInfo = Fiddle::Function.new(
  lib['GetMailslotInfo'],
  [
    Fiddle::TYPE_VOIDP,  # hMailslot : HANDLE
    Fiddle::TYPE_VOIDP,  # lpMaxMessageSize : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # lpNextSize : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # lpMessageCount : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # lpReadTimeout : DWORD* optional, out
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn GetMailslotInfo(
        hMailslot: *mut core::ffi::c_void,  // HANDLE
        lpMaxMessageSize: *mut u32,  // DWORD* optional, out
        lpNextSize: *mut u32,  // DWORD* optional, out
        lpMessageCount: *mut u32,  // DWORD* optional, out
        lpReadTimeout: *mut u32  // DWORD* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool GetMailslotInfo(IntPtr hMailslot, IntPtr lpMaxMessageSize, IntPtr lpNextSize, IntPtr lpMessageCount, IntPtr lpReadTimeout);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_GetMailslotInfo' -Namespace Win32 -PassThru
# $api::GetMailslotInfo(hMailslot, lpMaxMessageSize, lpNextSize, lpMessageCount, lpReadTimeout)
#uselib "KERNEL32.dll"
#func global GetMailslotInfo "GetMailslotInfo" sptr, sptr, sptr, sptr, sptr
; GetMailslotInfo hMailslot, varptr(lpMaxMessageSize), varptr(lpNextSize), varptr(lpMessageCount), varptr(lpReadTimeout)   ; 戻り値は stat
; hMailslot : HANDLE -> "sptr"
; lpMaxMessageSize : DWORD* optional, out -> "sptr"
; lpNextSize : DWORD* optional, out -> "sptr"
; lpMessageCount : DWORD* optional, out -> "sptr"
; lpReadTimeout : DWORD* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global GetMailslotInfo "GetMailslotInfo" sptr, var, var, var, var
; res = GetMailslotInfo(hMailslot, lpMaxMessageSize, lpNextSize, lpMessageCount, lpReadTimeout)
; hMailslot : HANDLE -> "sptr"
; lpMaxMessageSize : DWORD* optional, out -> "var"
; lpNextSize : DWORD* optional, out -> "var"
; lpMessageCount : DWORD* optional, out -> "var"
; lpReadTimeout : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL GetMailslotInfo(HANDLE hMailslot, DWORD* lpMaxMessageSize, DWORD* lpNextSize, DWORD* lpMessageCount, DWORD* lpReadTimeout)
#uselib "KERNEL32.dll"
#cfunc global GetMailslotInfo "GetMailslotInfo" intptr, var, var, var, var
; res = GetMailslotInfo(hMailslot, lpMaxMessageSize, lpNextSize, lpMessageCount, lpReadTimeout)
; hMailslot : HANDLE -> "intptr"
; lpMaxMessageSize : DWORD* optional, out -> "var"
; lpNextSize : DWORD* optional, out -> "var"
; lpMessageCount : DWORD* optional, out -> "var"
; lpReadTimeout : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procGetMailslotInfo = kernel32.NewProc("GetMailslotInfo")
)

// hMailslot (HANDLE), lpMaxMessageSize (DWORD* optional, out), lpNextSize (DWORD* optional, out), lpMessageCount (DWORD* optional, out), lpReadTimeout (DWORD* optional, out)
r1, _, err := procGetMailslotInfo.Call(
	uintptr(hMailslot),
	uintptr(lpMaxMessageSize),
	uintptr(lpNextSize),
	uintptr(lpMessageCount),
	uintptr(lpReadTimeout),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function GetMailslotInfo(
  hMailslot: THandle;   // HANDLE
  lpMaxMessageSize: Pointer;   // DWORD* optional, out
  lpNextSize: Pointer;   // DWORD* optional, out
  lpMessageCount: Pointer;   // DWORD* optional, out
  lpReadTimeout: Pointer   // DWORD* optional, out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'GetMailslotInfo';
result := DllCall("KERNEL32\GetMailslotInfo"
    , "Ptr", hMailslot   ; HANDLE
    , "Ptr", lpMaxMessageSize   ; DWORD* optional, out
    , "Ptr", lpNextSize   ; DWORD* optional, out
    , "Ptr", lpMessageCount   ; DWORD* optional, out
    , "Ptr", lpReadTimeout   ; DWORD* optional, out
    , "Int")   ; return: BOOL
●GetMailslotInfo(hMailslot, lpMaxMessageSize, lpNextSize, lpMessageCount, lpReadTimeout) = DLL("KERNEL32.dll", "bool GetMailslotInfo(void*, void*, void*, void*, void*)")
# 呼び出し: GetMailslotInfo(hMailslot, lpMaxMessageSize, lpNextSize, lpMessageCount, lpReadTimeout)
# hMailslot : HANDLE -> "void*"
# lpMaxMessageSize : DWORD* optional, out -> "void*"
# lpNextSize : DWORD* optional, out -> "void*"
# lpMessageCount : DWORD* optional, out -> "void*"
# lpReadTimeout : DWORD* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef GetMailslotInfoNative = Int32 Function(Pointer<Void>, Pointer<Uint32>, Pointer<Uint32>, Pointer<Uint32>, Pointer<Uint32>);
typedef GetMailslotInfoDart = int Function(Pointer<Void>, Pointer<Uint32>, Pointer<Uint32>, Pointer<Uint32>, Pointer<Uint32>);
final GetMailslotInfo = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<GetMailslotInfoNative, GetMailslotInfoDart>('GetMailslotInfo');
// hMailslot : HANDLE -> Pointer<Void>
// lpMaxMessageSize : DWORD* optional, out -> Pointer<Uint32>
// lpNextSize : DWORD* optional, out -> Pointer<Uint32>
// lpMessageCount : DWORD* optional, out -> Pointer<Uint32>
// lpReadTimeout : DWORD* optional, out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetMailslotInfo(
  hMailslot: THandle;   // HANDLE
  lpMaxMessageSize: Pointer;   // DWORD* optional, out
  lpNextSize: Pointer;   // DWORD* optional, out
  lpMessageCount: Pointer;   // DWORD* optional, out
  lpReadTimeout: Pointer   // DWORD* optional, out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'GetMailslotInfo';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetMailslotInfo"
  c_GetMailslotInfo :: Ptr () -> Ptr Word32 -> Ptr Word32 -> Ptr Word32 -> Ptr Word32 -> IO CInt
-- hMailslot : HANDLE -> Ptr ()
-- lpMaxMessageSize : DWORD* optional, out -> Ptr Word32
-- lpNextSize : DWORD* optional, out -> Ptr Word32
-- lpMessageCount : DWORD* optional, out -> Ptr Word32
-- lpReadTimeout : DWORD* optional, out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let getmailslotinfo =
  foreign "GetMailslotInfo"
    ((ptr void) @-> (ptr uint32_t) @-> (ptr uint32_t) @-> (ptr uint32_t) @-> (ptr uint32_t) @-> returning int32_t)
(* hMailslot : HANDLE -> (ptr void) *)
(* lpMaxMessageSize : DWORD* optional, out -> (ptr uint32_t) *)
(* lpNextSize : DWORD* optional, out -> (ptr uint32_t) *)
(* lpMessageCount : DWORD* optional, out -> (ptr uint32_t) *)
(* lpReadTimeout : DWORD* optional, out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("GetMailslotInfo" get-mailslot-info :convention :stdcall) :int32
  (h-mailslot :pointer)   ; HANDLE
  (lp-max-message-size :pointer)   ; DWORD* optional, out
  (lp-next-size :pointer)   ; DWORD* optional, out
  (lp-message-count :pointer)   ; DWORD* optional, out
  (lp-read-timeout :pointer))   ; DWORD* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetMailslotInfo = Win32::API::More->new('KERNEL32',
    'BOOL GetMailslotInfo(HANDLE hMailslot, LPVOID lpMaxMessageSize, LPVOID lpNextSize, LPVOID lpMessageCount, LPVOID lpReadTimeout)');
# my $ret = $GetMailslotInfo->Call($hMailslot, $lpMaxMessageSize, $lpNextSize, $lpMessageCount, $lpReadTimeout);
# hMailslot : HANDLE -> HANDLE
# lpMaxMessageSize : DWORD* optional, out -> LPVOID
# lpNextSize : DWORD* optional, out -> LPVOID
# lpMessageCount : DWORD* optional, out -> LPVOID
# lpReadTimeout : DWORD* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。