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

CreateMailslotW

関数
Unicode名でメールスロットを作成する。
DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

HANDLE CreateMailslotW(
    LPCWSTR lpName,
    DWORD nMaxMessageSize,
    DWORD lReadTimeout,
    SECURITY_ATTRIBUTES* lpSecurityAttributes   // optional
);

パラメーター

名前方向説明
lpNameLPCWSTRin作成するメールスロットの名前。\\.\mailslot\形式のワイド文字列で指定する。
nMaxMessageSizeDWORDin書き込み可能な1メッセージの最大バイト数。0で任意サイズを許可する。
lReadTimeoutDWORDin読み取り操作のタイムアウトをミリ秒で指定する。0で即時、MAILSLOT_WAIT_FOREVERで無限待機。
lpSecurityAttributesSECURITY_ATTRIBUTES*inoptionalセキュリティ記述子と継承可否を指定する構造体。NULLで既定値を使う。

戻り値の型: HANDLE

各言語での呼び出し定義

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

HANDLE CreateMailslotW(
    LPCWSTR lpName,
    DWORD nMaxMessageSize,
    DWORD lReadTimeout,
    SECURITY_ATTRIBUTES* lpSecurityAttributes   // optional
);
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern IntPtr CreateMailslotW(
    [MarshalAs(UnmanagedType.LPWStr)] string lpName,   // LPCWSTR
    uint nMaxMessageSize,   // DWORD
    uint lReadTimeout,   // DWORD
    IntPtr lpSecurityAttributes   // SECURITY_ATTRIBUTES* optional
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function CreateMailslotW(
    <MarshalAs(UnmanagedType.LPWStr)> lpName As String,   ' LPCWSTR
    nMaxMessageSize As UInteger,   ' DWORD
    lReadTimeout As UInteger,   ' DWORD
    lpSecurityAttributes As IntPtr   ' SECURITY_ATTRIBUTES* optional
) As IntPtr
End Function
' lpName : LPCWSTR
' nMaxMessageSize : DWORD
' lReadTimeout : DWORD
' lpSecurityAttributes : SECURITY_ATTRIBUTES* optional
Declare PtrSafe Function CreateMailslotW Lib "kernel32" ( _
    ByVal lpName As LongPtr, _
    ByVal nMaxMessageSize As Long, _
    ByVal lReadTimeout As Long, _
    ByVal lpSecurityAttributes As LongPtr) As LongPtr
' 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

CreateMailslotW = ctypes.windll.kernel32.CreateMailslotW
CreateMailslotW.restype = ctypes.c_void_p
CreateMailslotW.argtypes = [
    wintypes.LPCWSTR,  # lpName : LPCWSTR
    wintypes.DWORD,  # nMaxMessageSize : DWORD
    wintypes.DWORD,  # lReadTimeout : DWORD
    ctypes.c_void_p,  # lpSecurityAttributes : SECURITY_ATTRIBUTES* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
CreateMailslotW = Fiddle::Function.new(
  lib['CreateMailslotW'],
  [
    Fiddle::TYPE_VOIDP,  # lpName : LPCWSTR
    -Fiddle::TYPE_INT,  # nMaxMessageSize : DWORD
    -Fiddle::TYPE_INT,  # lReadTimeout : DWORD
    Fiddle::TYPE_VOIDP,  # lpSecurityAttributes : SECURITY_ATTRIBUTES* optional
  ],
  Fiddle::TYPE_VOIDP)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "kernel32")]
extern "system" {
    fn CreateMailslotW(
        lpName: *const u16,  // LPCWSTR
        nMaxMessageSize: u32,  // DWORD
        lReadTimeout: u32,  // DWORD
        lpSecurityAttributes: *mut SECURITY_ATTRIBUTES  // SECURITY_ATTRIBUTES* optional
    ) -> *mut core::ffi::c_void;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern IntPtr CreateMailslotW([MarshalAs(UnmanagedType.LPWStr)] string lpName, uint nMaxMessageSize, uint lReadTimeout, IntPtr lpSecurityAttributes);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_CreateMailslotW' -Namespace Win32 -PassThru
# $api::CreateMailslotW(lpName, nMaxMessageSize, lReadTimeout, lpSecurityAttributes)
#uselib "KERNEL32.dll"
#func global CreateMailslotW "CreateMailslotW" wptr, wptr, wptr, wptr
; CreateMailslotW lpName, nMaxMessageSize, lReadTimeout, varptr(lpSecurityAttributes)   ; 戻り値は stat
; lpName : LPCWSTR -> "wptr"
; nMaxMessageSize : DWORD -> "wptr"
; lReadTimeout : DWORD -> "wptr"
; lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global CreateMailslotW "CreateMailslotW" wstr, int, int, var
; res = CreateMailslotW(lpName, nMaxMessageSize, lReadTimeout, lpSecurityAttributes)
; lpName : LPCWSTR -> "wstr"
; nMaxMessageSize : DWORD -> "int"
; lReadTimeout : DWORD -> "int"
; lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HANDLE CreateMailslotW(LPCWSTR lpName, DWORD nMaxMessageSize, DWORD lReadTimeout, SECURITY_ATTRIBUTES* lpSecurityAttributes)
#uselib "KERNEL32.dll"
#cfunc global CreateMailslotW "CreateMailslotW" wstr, int, int, var
; res = CreateMailslotW(lpName, nMaxMessageSize, lReadTimeout, lpSecurityAttributes)
; lpName : LPCWSTR -> "wstr"
; nMaxMessageSize : DWORD -> "int"
; lReadTimeout : DWORD -> "int"
; lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procCreateMailslotW = kernel32.NewProc("CreateMailslotW")
)

// lpName (LPCWSTR), nMaxMessageSize (DWORD), lReadTimeout (DWORD), lpSecurityAttributes (SECURITY_ATTRIBUTES* optional)
r1, _, err := procCreateMailslotW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpName))),
	uintptr(nMaxMessageSize),
	uintptr(lReadTimeout),
	uintptr(lpSecurityAttributes),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HANDLE
function CreateMailslotW(
  lpName: PWideChar;   // LPCWSTR
  nMaxMessageSize: DWORD;   // DWORD
  lReadTimeout: DWORD;   // DWORD
  lpSecurityAttributes: Pointer   // SECURITY_ATTRIBUTES* optional
): THandle; stdcall;
  external 'KERNEL32.dll' name 'CreateMailslotW';
result := DllCall("KERNEL32\CreateMailslotW"
    , "WStr", lpName   ; LPCWSTR
    , "UInt", nMaxMessageSize   ; DWORD
    , "UInt", lReadTimeout   ; DWORD
    , "Ptr", lpSecurityAttributes   ; SECURITY_ATTRIBUTES* optional
    , "Ptr")   ; return: HANDLE
●CreateMailslotW(lpName, nMaxMessageSize, lReadTimeout, lpSecurityAttributes) = DLL("KERNEL32.dll", "void* CreateMailslotW(char*, dword, dword, void*)")
# 呼び出し: CreateMailslotW(lpName, nMaxMessageSize, lReadTimeout, lpSecurityAttributes)
# lpName : LPCWSTR -> "char*"
# nMaxMessageSize : DWORD -> "dword"
# lReadTimeout : DWORD -> "dword"
# lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "kernel32" fn CreateMailslotW(
    lpName: [*c]const u16, // LPCWSTR
    nMaxMessageSize: u32, // DWORD
    lReadTimeout: u32, // DWORD
    lpSecurityAttributes: [*c]SECURITY_ATTRIBUTES // SECURITY_ATTRIBUTES* optional
) callconv(std.os.windows.WINAPI) ?*anyopaque;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc CreateMailslotW(
    lpName: WideCString,  # LPCWSTR
    nMaxMessageSize: uint32,  # DWORD
    lReadTimeout: uint32,  # DWORD
    lpSecurityAttributes: ptr SECURITY_ATTRIBUTES  # SECURITY_ATTRIBUTES* optional
): pointer {.importc: "CreateMailslotW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "kernel32");
extern(Windows)
void* CreateMailslotW(
    const(wchar)* lpName,   // LPCWSTR
    uint nMaxMessageSize,   // DWORD
    uint lReadTimeout,   // DWORD
    SECURITY_ATTRIBUTES* lpSecurityAttributes   // SECURITY_ATTRIBUTES* optional
);
ccall((:CreateMailslotW, "KERNEL32.dll"), stdcall, Ptr{Cvoid},
      (Cwstring, UInt32, UInt32, Ptr{SECURITY_ATTRIBUTES}),
      lpName, nMaxMessageSize, lReadTimeout, lpSecurityAttributes)
# lpName : LPCWSTR -> Cwstring
# nMaxMessageSize : DWORD -> UInt32
# lReadTimeout : DWORD -> UInt32
# lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> Ptr{SECURITY_ATTRIBUTES}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
void* CreateMailslotW(
    const uint16_t* lpName,
    uint32_t nMaxMessageSize,
    uint32_t lReadTimeout,
    void* lpSecurityAttributes);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.CreateMailslotW(lpName, nMaxMessageSize, lReadTimeout, lpSecurityAttributes)
-- lpName : LPCWSTR
-- nMaxMessageSize : DWORD
-- lReadTimeout : DWORD
-- lpSecurityAttributes : SECURITY_ATTRIBUTES* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const CreateMailslotW = lib.func('__stdcall', 'CreateMailslotW', 'void *', ['str16', 'uint32_t', 'uint32_t', 'void *']);
// CreateMailslotW(lpName, nMaxMessageSize, lReadTimeout, lpSecurityAttributes)
// lpName : LPCWSTR -> 'str16'
// nMaxMessageSize : DWORD -> 'uint32_t'
// lReadTimeout : DWORD -> 'uint32_t'
// lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  CreateMailslotW: { parameters: ["buffer", "u32", "u32", "pointer"], result: "pointer" },
});
// lib.symbols.CreateMailslotW(lpName, nMaxMessageSize, lReadTimeout, lpSecurityAttributes)
// lpName : LPCWSTR -> "buffer"
// nMaxMessageSize : DWORD -> "u32"
// lReadTimeout : DWORD -> "u32"
// lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* CreateMailslotW(
    const uint16_t* lpName,
    uint32_t nMaxMessageSize,
    uint32_t lReadTimeout,
    void* lpSecurityAttributes);
C, "KERNEL32.dll");
// $ffi->CreateMailslotW(lpName, nMaxMessageSize, lReadTimeout, lpSecurityAttributes);
// lpName : LPCWSTR
// nMaxMessageSize : DWORD
// lReadTimeout : DWORD
// lpSecurityAttributes : SECURITY_ATTRIBUTES* optional
// 構造体/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, W32APIOptions.UNICODE_OPTIONS);
    Pointer CreateMailslotW(
        WString lpName,   // LPCWSTR
        int nMaxMessageSize,   // DWORD
        int lReadTimeout,   // DWORD
        Pointer lpSecurityAttributes   // SECURITY_ATTRIBUTES* optional
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("kernel32")]
lib LibKERNEL32
  fun CreateMailslotW = CreateMailslotW(
    lpName : UInt16*,   # LPCWSTR
    nMaxMessageSize : UInt32,   # DWORD
    lReadTimeout : UInt32,   # DWORD
    lpSecurityAttributes : SECURITY_ATTRIBUTES*   # SECURITY_ATTRIBUTES* optional
  ) : Void*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef CreateMailslotWNative = Pointer<Void> Function(Pointer<Utf16>, Uint32, Uint32, Pointer<Void>);
typedef CreateMailslotWDart = Pointer<Void> Function(Pointer<Utf16>, int, int, Pointer<Void>);
final CreateMailslotW = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<CreateMailslotWNative, CreateMailslotWDart>('CreateMailslotW');
// lpName : LPCWSTR -> Pointer<Utf16>
// nMaxMessageSize : DWORD -> Uint32
// lReadTimeout : DWORD -> Uint32
// lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function CreateMailslotW(
  lpName: PWideChar;   // LPCWSTR
  nMaxMessageSize: DWORD;   // DWORD
  lReadTimeout: DWORD;   // DWORD
  lpSecurityAttributes: Pointer   // SECURITY_ATTRIBUTES* optional
): THandle; stdcall;
  external 'KERNEL32.dll' name 'CreateMailslotW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "CreateMailslotW"
  c_CreateMailslotW :: CWString -> Word32 -> Word32 -> Ptr () -> IO (Ptr ())
-- lpName : LPCWSTR -> CWString
-- nMaxMessageSize : DWORD -> Word32
-- lReadTimeout : DWORD -> Word32
-- lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let createmailslotw =
  foreign "CreateMailslotW"
    ((ptr uint16_t) @-> uint32_t @-> uint32_t @-> (ptr void) @-> returning (ptr void))
(* lpName : LPCWSTR -> (ptr uint16_t) *)
(* nMaxMessageSize : DWORD -> uint32_t *)
(* lReadTimeout : DWORD -> uint32_t *)
(* lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("CreateMailslotW" create-mailslot-w :convention :stdcall) :pointer
  (lp-name (:string :encoding :utf-16le))   ; LPCWSTR
  (n-max-message-size :uint32)   ; DWORD
  (l-read-timeout :uint32)   ; DWORD
  (lp-security-attributes :pointer))   ; SECURITY_ATTRIBUTES* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $CreateMailslotW = Win32::API::More->new('KERNEL32',
    'HANDLE CreateMailslotW(LPCWSTR lpName, DWORD nMaxMessageSize, DWORD lReadTimeout, LPVOID lpSecurityAttributes)');
# my $ret = $CreateMailslotW->Call($lpName, $nMaxMessageSize, $lReadTimeout, $lpSecurityAttributes);
# lpName : LPCWSTR -> LPCWSTR
# nMaxMessageSize : DWORD -> DWORD
# lReadTimeout : DWORD -> DWORD
# lpSecurityAttributes : SECURITY_ATTRIBUTES* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
使用する型