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

MQOpenQueue

関数
メッセージ送受信のためにキューを開く。
DLLmqrt.dll呼出規約winapi

シグネチャ

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

HRESULT MQOpenQueue(
    LPCWSTR lpwcsFormatName,
    DWORD dwAccess,
    DWORD dwShareMode,
    INT_PTR* phQueue
);

パラメーター

名前方向説明
lpwcsFormatNameLPCWSTRin開くキューのフォーマット名(ワイド文字列)を指定する。
dwAccessDWORDinアクセスモード。MQ_RECEIVE_ACCESSやMQ_SEND_ACCESS、MQ_PEEK_ACCESS等を指定する。
dwShareModeDWORDin共有モード。MQ_DENY_NONEまたはMQ_DENY_RECEIVE_SHAREを指定する。
phQueueINT_PTR*out開いたキューのハンドルを受け取るINT_PTRへのポインタを指定する。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT MQOpenQueue(
    LPCWSTR lpwcsFormatName,
    DWORD dwAccess,
    DWORD dwShareMode,
    INT_PTR* phQueue
);
[DllImport("mqrt.dll", ExactSpelling = true)]
static extern int MQOpenQueue(
    [MarshalAs(UnmanagedType.LPWStr)] string lpwcsFormatName,   // LPCWSTR
    uint dwAccess,   // DWORD
    uint dwShareMode,   // DWORD
    out IntPtr phQueue   // INT_PTR* out
);
<DllImport("mqrt.dll", ExactSpelling:=True)>
Public Shared Function MQOpenQueue(
    <MarshalAs(UnmanagedType.LPWStr)> lpwcsFormatName As String,   ' LPCWSTR
    dwAccess As UInteger,   ' DWORD
    dwShareMode As UInteger,   ' DWORD
    <Out> ByRef phQueue As IntPtr   ' INT_PTR* out
) As Integer
End Function
' lpwcsFormatName : LPCWSTR
' dwAccess : DWORD
' dwShareMode : DWORD
' phQueue : INT_PTR* out
Declare PtrSafe Function MQOpenQueue Lib "mqrt" ( _
    ByVal lpwcsFormatName As LongPtr, _
    ByVal dwAccess As Long, _
    ByVal dwShareMode As Long, _
    ByRef phQueue As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

MQOpenQueue = ctypes.windll.mqrt.MQOpenQueue
MQOpenQueue.restype = ctypes.c_int
MQOpenQueue.argtypes = [
    wintypes.LPCWSTR,  # lpwcsFormatName : LPCWSTR
    wintypes.DWORD,  # dwAccess : DWORD
    wintypes.DWORD,  # dwShareMode : DWORD
    ctypes.POINTER(ctypes.c_ssize_t),  # phQueue : INT_PTR* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('mqrt.dll')
MQOpenQueue = Fiddle::Function.new(
  lib['MQOpenQueue'],
  [
    Fiddle::TYPE_VOIDP,  # lpwcsFormatName : LPCWSTR
    -Fiddle::TYPE_INT,  # dwAccess : DWORD
    -Fiddle::TYPE_INT,  # dwShareMode : DWORD
    Fiddle::TYPE_VOIDP,  # phQueue : INT_PTR* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "mqrt")]
extern "system" {
    fn MQOpenQueue(
        lpwcsFormatName: *const u16,  // LPCWSTR
        dwAccess: u32,  // DWORD
        dwShareMode: u32,  // DWORD
        phQueue: *mut isize  // INT_PTR* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("mqrt.dll")]
public static extern int MQOpenQueue([MarshalAs(UnmanagedType.LPWStr)] string lpwcsFormatName, uint dwAccess, uint dwShareMode, out IntPtr phQueue);
"@
$api = Add-Type -MemberDefinition $sig -Name 'mqrt_MQOpenQueue' -Namespace Win32 -PassThru
# $api::MQOpenQueue(lpwcsFormatName, dwAccess, dwShareMode, phQueue)
#uselib "mqrt.dll"
#func global MQOpenQueue "MQOpenQueue" sptr, sptr, sptr, sptr
; MQOpenQueue lpwcsFormatName, dwAccess, dwShareMode, varptr(phQueue)   ; 戻り値は stat
; lpwcsFormatName : LPCWSTR -> "sptr"
; dwAccess : DWORD -> "sptr"
; dwShareMode : DWORD -> "sptr"
; phQueue : INT_PTR* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "mqrt.dll"
#cfunc global MQOpenQueue "MQOpenQueue" wstr, int, int, var
; res = MQOpenQueue(lpwcsFormatName, dwAccess, dwShareMode, phQueue)
; lpwcsFormatName : LPCWSTR -> "wstr"
; dwAccess : DWORD -> "int"
; dwShareMode : DWORD -> "int"
; phQueue : INT_PTR* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT MQOpenQueue(LPCWSTR lpwcsFormatName, DWORD dwAccess, DWORD dwShareMode, INT_PTR* phQueue)
#uselib "mqrt.dll"
#cfunc global MQOpenQueue "MQOpenQueue" wstr, int, int, var
; res = MQOpenQueue(lpwcsFormatName, dwAccess, dwShareMode, phQueue)
; lpwcsFormatName : LPCWSTR -> "wstr"
; dwAccess : DWORD -> "int"
; dwShareMode : DWORD -> "int"
; phQueue : INT_PTR* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	mqrt = windows.NewLazySystemDLL("mqrt.dll")
	procMQOpenQueue = mqrt.NewProc("MQOpenQueue")
)

// lpwcsFormatName (LPCWSTR), dwAccess (DWORD), dwShareMode (DWORD), phQueue (INT_PTR* out)
r1, _, err := procMQOpenQueue.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpwcsFormatName))),
	uintptr(dwAccess),
	uintptr(dwShareMode),
	uintptr(phQueue),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function MQOpenQueue(
  lpwcsFormatName: PWideChar;   // LPCWSTR
  dwAccess: DWORD;   // DWORD
  dwShareMode: DWORD;   // DWORD
  phQueue: Pointer   // INT_PTR* out
): Integer; stdcall;
  external 'mqrt.dll' name 'MQOpenQueue';
result := DllCall("mqrt\MQOpenQueue"
    , "WStr", lpwcsFormatName   ; LPCWSTR
    , "UInt", dwAccess   ; DWORD
    , "UInt", dwShareMode   ; DWORD
    , "Ptr", phQueue   ; INT_PTR* out
    , "Int")   ; return: HRESULT
●MQOpenQueue(lpwcsFormatName, dwAccess, dwShareMode, phQueue) = DLL("mqrt.dll", "int MQOpenQueue(char*, dword, dword, void*)")
# 呼び出し: MQOpenQueue(lpwcsFormatName, dwAccess, dwShareMode, phQueue)
# lpwcsFormatName : LPCWSTR -> "char*"
# dwAccess : DWORD -> "dword"
# dwShareMode : DWORD -> "dword"
# phQueue : INT_PTR* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef MQOpenQueueNative = Int32 Function(Pointer<Utf16>, Uint32, Uint32, Pointer<IntPtr>);
typedef MQOpenQueueDart = int Function(Pointer<Utf16>, int, int, Pointer<IntPtr>);
final MQOpenQueue = DynamicLibrary.open('mqrt.dll')
    .lookupFunction<MQOpenQueueNative, MQOpenQueueDart>('MQOpenQueue');
// lpwcsFormatName : LPCWSTR -> Pointer<Utf16>
// dwAccess : DWORD -> Uint32
// dwShareMode : DWORD -> Uint32
// phQueue : INT_PTR* out -> Pointer<IntPtr>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MQOpenQueue(
  lpwcsFormatName: PWideChar;   // LPCWSTR
  dwAccess: DWORD;   // DWORD
  dwShareMode: DWORD;   // DWORD
  phQueue: Pointer   // INT_PTR* out
): Integer; stdcall;
  external 'mqrt.dll' name 'MQOpenQueue';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MQOpenQueue"
  c_MQOpenQueue :: CWString -> Word32 -> Word32 -> Ptr CIntPtr -> IO Int32
-- lpwcsFormatName : LPCWSTR -> CWString
-- dwAccess : DWORD -> Word32
-- dwShareMode : DWORD -> Word32
-- phQueue : INT_PTR* out -> Ptr CIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let mqopenqueue =
  foreign "MQOpenQueue"
    ((ptr uint16_t) @-> uint32_t @-> uint32_t @-> (ptr intptr_t) @-> returning int32_t)
(* lpwcsFormatName : LPCWSTR -> (ptr uint16_t) *)
(* dwAccess : DWORD -> uint32_t *)
(* dwShareMode : DWORD -> uint32_t *)
(* phQueue : INT_PTR* out -> (ptr intptr_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library mqrt (t "mqrt.dll"))
(cffi:use-foreign-library mqrt)

(cffi:defcfun ("MQOpenQueue" mqopen-queue :convention :stdcall) :int32
  (lpwcs-format-name (:string :encoding :utf-16le))   ; LPCWSTR
  (dw-access :uint32)   ; DWORD
  (dw-share-mode :uint32)   ; DWORD
  (ph-queue :pointer))   ; INT_PTR* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MQOpenQueue = Win32::API::More->new('mqrt',
    'int MQOpenQueue(LPCWSTR lpwcsFormatName, DWORD dwAccess, DWORD dwShareMode, LPVOID phQueue)');
# my $ret = $MQOpenQueue->Call($lpwcsFormatName, $dwAccess, $dwShareMode, $phQueue);
# lpwcsFormatName : LPCWSTR -> LPCWSTR
# dwAccess : DWORD -> DWORD
# dwShareMode : DWORD -> DWORD
# phQueue : INT_PTR* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。