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

MQPurgeQueue

関数
指定キュー内のすべてのメッセージを削除する。
DLLmqrt.dll呼出規約winapi

シグネチャ

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

HRESULT MQPurgeQueue(
    INT_PTR hQueue
);

パラメーター

名前方向説明
hQueueINT_PTRin全メッセージを削除(パージ)する対象の開いているキューのハンドルを指定する。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT MQPurgeQueue(
    INT_PTR hQueue
);
[DllImport("mqrt.dll", ExactSpelling = true)]
static extern int MQPurgeQueue(
    IntPtr hQueue   // INT_PTR
);
<DllImport("mqrt.dll", ExactSpelling:=True)>
Public Shared Function MQPurgeQueue(
    hQueue As IntPtr   ' INT_PTR
) As Integer
End Function
' hQueue : INT_PTR
Declare PtrSafe Function MQPurgeQueue Lib "mqrt" ( _
    ByVal hQueue As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

MQPurgeQueue = ctypes.windll.mqrt.MQPurgeQueue
MQPurgeQueue.restype = ctypes.c_int
MQPurgeQueue.argtypes = [
    ctypes.c_ssize_t,  # hQueue : INT_PTR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('mqrt.dll')
MQPurgeQueue = Fiddle::Function.new(
  lib['MQPurgeQueue'],
  [
    Fiddle::TYPE_INTPTR_T,  # hQueue : INT_PTR
  ],
  Fiddle::TYPE_INT)
#[link(name = "mqrt")]
extern "system" {
    fn MQPurgeQueue(
        hQueue: isize  // INT_PTR
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("mqrt.dll")]
public static extern int MQPurgeQueue(IntPtr hQueue);
"@
$api = Add-Type -MemberDefinition $sig -Name 'mqrt_MQPurgeQueue' -Namespace Win32 -PassThru
# $api::MQPurgeQueue(hQueue)
#uselib "mqrt.dll"
#func global MQPurgeQueue "MQPurgeQueue" sptr
; MQPurgeQueue hQueue   ; 戻り値は stat
; hQueue : INT_PTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "mqrt.dll"
#cfunc global MQPurgeQueue "MQPurgeQueue" sptr
; res = MQPurgeQueue(hQueue)
; hQueue : INT_PTR -> "sptr"
; HRESULT MQPurgeQueue(INT_PTR hQueue)
#uselib "mqrt.dll"
#cfunc global MQPurgeQueue "MQPurgeQueue" intptr
; res = MQPurgeQueue(hQueue)
; hQueue : INT_PTR -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	mqrt = windows.NewLazySystemDLL("mqrt.dll")
	procMQPurgeQueue = mqrt.NewProc("MQPurgeQueue")
)

// hQueue (INT_PTR)
r1, _, err := procMQPurgeQueue.Call(
	uintptr(hQueue),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function MQPurgeQueue(
  hQueue: NativeInt   // INT_PTR
): Integer; stdcall;
  external 'mqrt.dll' name 'MQPurgeQueue';
result := DllCall("mqrt\MQPurgeQueue"
    , "Ptr", hQueue   ; INT_PTR
    , "Int")   ; return: HRESULT
●MQPurgeQueue(hQueue) = DLL("mqrt.dll", "int MQPurgeQueue(int)")
# 呼び出し: MQPurgeQueue(hQueue)
# hQueue : INT_PTR -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef MQPurgeQueueNative = Int32 Function(IntPtr);
typedef MQPurgeQueueDart = int Function(int);
final MQPurgeQueue = DynamicLibrary.open('mqrt.dll')
    .lookupFunction<MQPurgeQueueNative, MQPurgeQueueDart>('MQPurgeQueue');
// hQueue : INT_PTR -> IntPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MQPurgeQueue(
  hQueue: NativeInt   // INT_PTR
): Integer; stdcall;
  external 'mqrt.dll' name 'MQPurgeQueue';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MQPurgeQueue"
  c_MQPurgeQueue :: CIntPtr -> IO Int32
-- hQueue : INT_PTR -> CIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let mqpurgequeue =
  foreign "MQPurgeQueue"
    (intptr_t @-> returning int32_t)
(* hQueue : INT_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 ("MQPurgeQueue" mqpurge-queue :convention :stdcall) :int32
  (h-queue :int64))   ; INT_PTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MQPurgeQueue = Win32::API::More->new('mqrt',
    'int MQPurgeQueue(LPARAM hQueue)');
# my $ret = $MQPurgeQueue->Call($hQueue);
# hQueue : INT_PTR -> LPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。