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
RoutingGuidLPCWSTRin
RoutingInfoBufferBYTE**out
RoutingInfoBufferSizeDWORD*out

戻り値の型: 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 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 版の利用を推奨。