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

MQLocateBegin

関数
ディレクトリ内のキュー問い合わせ検索を開始する。
DLLmqrt.dll呼出規約winapi

シグネチャ

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

HRESULT MQLocateBegin(
    LPCWSTR lpwcsContext,   // optional
    MQRESTRICTION* pRestriction,   // optional
    MQCOLUMNSET* pColumns,
    MQSORTSET* pSort,
    HANDLE* phEnum
);

パラメーター

名前型方向説明
lpwcsContextLPCWSTRinoptional検索を開始するディレクトリ階層のコンテキスト名。NULL可でエンタープライズ全体が対象となる。
pRestrictionMQRESTRICTION*inoptional検索の絞り込み条件を指定するMQRESTRICTION構造体へのポインタ。NULL可で全件対象となる。
pColumnsMQCOLUMNSET*in結果として取得するプロパティ列を指定するMQCOLUMNSET構造体へのポインタを指定する。
pSortMQSORTSET*in結果のソート順を指定するMQSORTSET構造体へのポインタ。NULL可でソートなしとなる。
phEnumHANDLE*out生成された検索列挙ハンドルを受け取るポインタを指定する。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT MQLocateBegin(
    LPCWSTR lpwcsContext,   // optional
    MQRESTRICTION* pRestriction,   // optional
    MQCOLUMNSET* pColumns,
    MQSORTSET* pSort,
    HANDLE* phEnum
);
[DllImport("mqrt.dll", ExactSpelling = true)]
static extern int MQLocateBegin(
    [MarshalAs(UnmanagedType.LPWStr)] string lpwcsContext,   // LPCWSTR optional
    IntPtr pRestriction,   // MQRESTRICTION* optional
    IntPtr pColumns,   // MQCOLUMNSET*
    IntPtr pSort,   // MQSORTSET*
    IntPtr phEnum   // HANDLE* out
);
<DllImport("mqrt.dll", ExactSpelling:=True)>
Public Shared Function MQLocateBegin(
    <MarshalAs(UnmanagedType.LPWStr)> lpwcsContext As String,   ' LPCWSTR optional
    pRestriction As IntPtr,   ' MQRESTRICTION* optional
    pColumns As IntPtr,   ' MQCOLUMNSET*
    pSort As IntPtr,   ' MQSORTSET*
    phEnum As IntPtr   ' HANDLE* out
) As Integer
End Function
' lpwcsContext : LPCWSTR optional
' pRestriction : MQRESTRICTION* optional
' pColumns : MQCOLUMNSET*
' pSort : MQSORTSET*
' phEnum : HANDLE* out
Declare PtrSafe Function MQLocateBegin Lib "mqrt" ( _
    ByVal lpwcsContext As LongPtr, _
    ByVal pRestriction As LongPtr, _
    ByVal pColumns As LongPtr, _
    ByVal pSort As LongPtr, _
    ByVal phEnum As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

MQLocateBegin = ctypes.windll.mqrt.MQLocateBegin
MQLocateBegin.restype = ctypes.c_int
MQLocateBegin.argtypes = [
    wintypes.LPCWSTR,  # lpwcsContext : LPCWSTR optional
    ctypes.c_void_p,  # pRestriction : MQRESTRICTION* optional
    ctypes.c_void_p,  # pColumns : MQCOLUMNSET*
    ctypes.c_void_p,  # pSort : MQSORTSET*
    ctypes.c_void_p,  # phEnum : HANDLE* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	mqrt = windows.NewLazySystemDLL("mqrt.dll")
	procMQLocateBegin = mqrt.NewProc("MQLocateBegin")
)

// lpwcsContext (LPCWSTR optional), pRestriction (MQRESTRICTION* optional), pColumns (MQCOLUMNSET*), pSort (MQSORTSET*), phEnum (HANDLE* out)
r1, _, err := procMQLocateBegin.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(lpwcsContext))),
	uintptr(pRestriction),
	uintptr(pColumns),
	uintptr(pSort),
	uintptr(phEnum),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function MQLocateBegin(
  lpwcsContext: PWideChar;   // LPCWSTR optional
  pRestriction: Pointer;   // MQRESTRICTION* optional
  pColumns: Pointer;   // MQCOLUMNSET*
  pSort: Pointer;   // MQSORTSET*
  phEnum: Pointer   // HANDLE* out
): Integer; stdcall;
  external 'mqrt.dll' name 'MQLocateBegin';
result := DllCall("mqrt\MQLocateBegin"
    , "WStr", lpwcsContext   ; LPCWSTR optional
    , "Ptr", pRestriction   ; MQRESTRICTION* optional
    , "Ptr", pColumns   ; MQCOLUMNSET*
    , "Ptr", pSort   ; MQSORTSET*
    , "Ptr", phEnum   ; HANDLE* out
    , "Int")   ; return: HRESULT
●MQLocateBegin(lpwcsContext, pRestriction, pColumns, pSort, phEnum) = DLL("mqrt.dll", "int MQLocateBegin(char*, void*, void*, void*, void*)")
# 呼び出し: MQLocateBegin(lpwcsContext, pRestriction, pColumns, pSort, phEnum)
# lpwcsContext : LPCWSTR optional -> "char*"
# pRestriction : MQRESTRICTION* optional -> "void*"
# pColumns : MQCOLUMNSET* -> "void*"
# pSort : MQSORTSET* -> "void*"
# phEnum : HANDLE* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef MQLocateBeginNative = Int32 Function(Pointer<Utf16>, Pointer<Void>, Pointer<Void>, Pointer<Void>, Pointer<Void>);
typedef MQLocateBeginDart = int Function(Pointer<Utf16>, Pointer<Void>, Pointer<Void>, Pointer<Void>, Pointer<Void>);
final MQLocateBegin = DynamicLibrary.open('mqrt.dll')
    .lookupFunction<MQLocateBeginNative, MQLocateBeginDart>('MQLocateBegin');
// lpwcsContext : LPCWSTR optional -> Pointer<Utf16>
// pRestriction : MQRESTRICTION* optional -> Pointer<Void>
// pColumns : MQCOLUMNSET* -> Pointer<Void>
// pSort : MQSORTSET* -> Pointer<Void>
// phEnum : HANDLE* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MQLocateBegin(
  lpwcsContext: PWideChar;   // LPCWSTR optional
  pRestriction: Pointer;   // MQRESTRICTION* optional
  pColumns: Pointer;   // MQCOLUMNSET*
  pSort: Pointer;   // MQSORTSET*
  phEnum: Pointer   // HANDLE* out
): Integer; stdcall;
  external 'mqrt.dll' name 'MQLocateBegin';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MQLocateBegin"
  c_MQLocateBegin :: CWString -> Ptr () -> Ptr () -> Ptr () -> Ptr () -> IO Int32
-- lpwcsContext : LPCWSTR optional -> CWString
-- pRestriction : MQRESTRICTION* optional -> Ptr ()
-- pColumns : MQCOLUMNSET* -> Ptr ()
-- pSort : MQSORTSET* -> Ptr ()
-- phEnum : HANDLE* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let mqlocatebegin =
  foreign "MQLocateBegin"
    ((ptr uint16_t) @-> (ptr void) @-> (ptr void) @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* lpwcsContext : LPCWSTR optional -> (ptr uint16_t) *)
(* pRestriction : MQRESTRICTION* optional -> (ptr void) *)
(* pColumns : MQCOLUMNSET* -> (ptr void) *)
(* pSort : MQSORTSET* -> (ptr void) *)
(* phEnum : HANDLE* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library mqrt (t "mqrt.dll"))
(cffi:use-foreign-library mqrt)

(cffi:defcfun ("MQLocateBegin" mqlocate-begin :convention :stdcall) :int32
  (lpwcs-context (:string :encoding :utf-16le))   ; LPCWSTR optional
  (p-restriction :pointer)   ; MQRESTRICTION* optional
  (p-columns :pointer)   ; MQCOLUMNSET*
  (p-sort :pointer)   ; MQSORTSET*
  (ph-enum :pointer))   ; HANDLE* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MQLocateBegin = Win32::API::More->new('mqrt',
    'int MQLocateBegin(LPCWSTR lpwcsContext, LPVOID pRestriction, LPVOID pColumns, LPVOID pSort, HANDLE phEnum)');
# my $ret = $MQLocateBegin->Call($lpwcsContext, $pRestriction, $pColumns, $pSort, $phEnum);
# lpwcsContext : LPCWSTR optional -> LPCWSTR
# pRestriction : MQRESTRICTION* optional -> LPVOID
# pColumns : MQCOLUMNSET* -> LPVOID
# pSort : MQSORTSET* -> LPVOID
# phEnum : HANDLE* out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型