Win32 API 日本語リファレンス
ホームDevices.Fax › FaxGetRoutingInfoW

FaxGetRoutingInfoW

関数
指定したルーティング方法の構成データを取得する。
DLLWINFAX.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL FaxGetRoutingInfoW(
    HANDLE FaxPortHandle,
    LPCWSTR RoutingGuid,
    BYTE** RoutingInfoBuffer,
    DWORD* RoutingInfoBufferSize
);

パラメーター

名前方向説明
FaxPortHandleHANDLEin対象のFAXポートハンドルを指定する。
RoutingGuidLPCWSTRin情報を取得するルーティングメソッドのGUID文字列(Unicode)を指定する。
RoutingInfoBufferBYTE**outルーティング情報データを受け取るバッファポインタを返すポインタ。FaxFreeBufferで解放する。
RoutingInfoBufferSizeDWORD*out返されたデータのバイトサイズを受け取るDWORDへのポインタを指定する。出力専用。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL FaxGetRoutingInfoW(
    HANDLE FaxPortHandle,
    LPCWSTR RoutingGuid,
    BYTE** RoutingInfoBuffer,
    DWORD* RoutingInfoBufferSize
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINFAX.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool FaxGetRoutingInfoW(
    IntPtr FaxPortHandle,   // HANDLE
    [MarshalAs(UnmanagedType.LPWStr)] string RoutingGuid,   // LPCWSTR
    IntPtr RoutingInfoBuffer,   // BYTE** out
    out uint RoutingInfoBufferSize   // DWORD* out
);
<DllImport("WINFAX.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FaxGetRoutingInfoW(
    FaxPortHandle As IntPtr,   ' HANDLE
    <MarshalAs(UnmanagedType.LPWStr)> RoutingGuid As String,   ' LPCWSTR
    RoutingInfoBuffer As IntPtr,   ' BYTE** out
    <Out> ByRef RoutingInfoBufferSize As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' FaxPortHandle : HANDLE
' RoutingGuid : LPCWSTR
' RoutingInfoBuffer : BYTE** out
' RoutingInfoBufferSize : DWORD* out
Declare PtrSafe Function FaxGetRoutingInfoW Lib "winfax" ( _
    ByVal FaxPortHandle As LongPtr, _
    ByVal RoutingGuid As LongPtr, _
    ByVal RoutingInfoBuffer As LongPtr, _
    ByRef RoutingInfoBufferSize As Long) As Long
' 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

FaxGetRoutingInfoW = ctypes.windll.winfax.FaxGetRoutingInfoW
FaxGetRoutingInfoW.restype = wintypes.BOOL
FaxGetRoutingInfoW.argtypes = [
    wintypes.HANDLE,  # FaxPortHandle : HANDLE
    wintypes.LPCWSTR,  # RoutingGuid : LPCWSTR
    ctypes.c_void_p,  # RoutingInfoBuffer : BYTE** out
    ctypes.POINTER(wintypes.DWORD),  # RoutingInfoBufferSize : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

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

var (
	winfax = windows.NewLazySystemDLL("WINFAX.dll")
	procFaxGetRoutingInfoW = winfax.NewProc("FaxGetRoutingInfoW")
)

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

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

typedef FaxGetRoutingInfoWNative = Int32 Function(Pointer<Void>, Pointer<Utf16>, Pointer<Uint8>, Pointer<Uint32>);
typedef FaxGetRoutingInfoWDart = int Function(Pointer<Void>, Pointer<Utf16>, Pointer<Uint8>, Pointer<Uint32>);
final FaxGetRoutingInfoW = DynamicLibrary.open('WINFAX.dll')
    .lookupFunction<FaxGetRoutingInfoWNative, FaxGetRoutingInfoWDart>('FaxGetRoutingInfoW');
// FaxPortHandle : HANDLE -> Pointer<Void>
// RoutingGuid : LPCWSTR -> Pointer<Utf16>
// RoutingInfoBuffer : BYTE** out -> Pointer<Uint8>
// RoutingInfoBufferSize : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FaxGetRoutingInfoW(
  FaxPortHandle: THandle;   // HANDLE
  RoutingGuid: PWideChar;   // LPCWSTR
  RoutingInfoBuffer: Pointer;   // BYTE** out
  RoutingInfoBufferSize: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'WINFAX.dll' name 'FaxGetRoutingInfoW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "FaxGetRoutingInfoW"
  c_FaxGetRoutingInfoW :: Ptr () -> CWString -> Ptr Word8 -> Ptr Word32 -> IO CInt
-- FaxPortHandle : HANDLE -> Ptr ()
-- RoutingGuid : LPCWSTR -> CWString
-- RoutingInfoBuffer : BYTE** out -> Ptr Word8
-- RoutingInfoBufferSize : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let faxgetroutinginfow =
  foreign "FaxGetRoutingInfoW"
    ((ptr void) @-> (ptr uint16_t) @-> (ptr uint8_t) @-> (ptr uint32_t) @-> returning int32_t)
(* FaxPortHandle : HANDLE -> (ptr void) *)
(* RoutingGuid : LPCWSTR -> (ptr uint16_t) *)
(* RoutingInfoBuffer : BYTE** out -> (ptr uint8_t) *)
(* RoutingInfoBufferSize : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winfax (t "WINFAX.dll"))
(cffi:use-foreign-library winfax)

(cffi:defcfun ("FaxGetRoutingInfoW" fax-get-routing-info-w :convention :stdcall) :int32
  (fax-port-handle :pointer)   ; HANDLE
  (routing-guid (:string :encoding :utf-16le))   ; LPCWSTR
  (routing-info-buffer :pointer)   ; BYTE** out
  (routing-info-buffer-size :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FaxGetRoutingInfoW = Win32::API::More->new('WINFAX',
    'BOOL FaxGetRoutingInfoW(HANDLE FaxPortHandle, LPCWSTR RoutingGuid, LPVOID RoutingInfoBuffer, LPVOID RoutingInfoBufferSize)');
# my $ret = $FaxGetRoutingInfoW->Call($FaxPortHandle, $RoutingGuid, $RoutingInfoBuffer, $RoutingInfoBufferSize);
# FaxPortHandle : HANDLE -> HANDLE
# RoutingGuid : LPCWSTR -> LPCWSTR
# RoutingInfoBuffer : BYTE** out -> LPVOID
# RoutingInfoBufferSize : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い