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

FaxGetRoutingInfoA

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

シグネチャ

// WINFAX.dll  (ANSI / -A)
#include <windows.h>

BOOL FaxGetRoutingInfoA(
    HANDLE FaxPortHandle,
    LPCSTR RoutingGuid,
    BYTE** RoutingInfoBuffer,
    DWORD* RoutingInfoBufferSize
);

パラメーター

名前方向
FaxPortHandleHANDLEin
RoutingGuidLPCSTRin
RoutingInfoBufferBYTE**out
RoutingInfoBufferSizeDWORD*out

戻り値の型: BOOL

各言語での呼び出し定義

// WINFAX.dll  (ANSI / -A)
#include <windows.h>

BOOL FaxGetRoutingInfoA(
    HANDLE FaxPortHandle,
    LPCSTR RoutingGuid,
    BYTE** RoutingInfoBuffer,
    DWORD* RoutingInfoBufferSize
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINFAX.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool FaxGetRoutingInfoA(
    IntPtr FaxPortHandle,   // HANDLE
    [MarshalAs(UnmanagedType.LPStr)] string RoutingGuid,   // LPCSTR
    IntPtr RoutingInfoBuffer,   // BYTE** out
    out uint RoutingInfoBufferSize   // DWORD* out
);
<DllImport("WINFAX.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FaxGetRoutingInfoA(
    FaxPortHandle As IntPtr,   ' HANDLE
    <MarshalAs(UnmanagedType.LPStr)> RoutingGuid As String,   ' LPCSTR
    RoutingInfoBuffer As IntPtr,   ' BYTE** out
    <Out> ByRef RoutingInfoBufferSize As UInteger   ' DWORD* out
) As Boolean
End Function
' FaxPortHandle : HANDLE
' RoutingGuid : LPCSTR
' RoutingInfoBuffer : BYTE** out
' RoutingInfoBufferSize : DWORD* out
Declare PtrSafe Function FaxGetRoutingInfoA Lib "winfax" ( _
    ByVal FaxPortHandle As LongPtr, _
    ByVal RoutingGuid As String, _
    ByVal RoutingInfoBuffer As LongPtr, _
    ByRef RoutingInfoBufferSize As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

FaxGetRoutingInfoA = ctypes.windll.winfax.FaxGetRoutingInfoA
FaxGetRoutingInfoA.restype = wintypes.BOOL
FaxGetRoutingInfoA.argtypes = [
    wintypes.HANDLE,  # FaxPortHandle : HANDLE
    wintypes.LPCSTR,  # RoutingGuid : LPCSTR
    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')
FaxGetRoutingInfoA = Fiddle::Function.new(
  lib['FaxGetRoutingInfoA'],
  [
    Fiddle::TYPE_VOIDP,  # FaxPortHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # RoutingGuid : LPCSTR
    Fiddle::TYPE_VOIDP,  # RoutingInfoBuffer : BYTE** out
    Fiddle::TYPE_VOIDP,  # RoutingInfoBufferSize : DWORD* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "winfax")]
extern "system" {
    fn FaxGetRoutingInfoA(
        FaxPortHandle: *mut core::ffi::c_void,  // HANDLE
        RoutingGuid: *const u8,  // LPCSTR
        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.Ansi, SetLastError = true)]
public static extern bool FaxGetRoutingInfoA(IntPtr FaxPortHandle, [MarshalAs(UnmanagedType.LPStr)] string RoutingGuid, IntPtr RoutingInfoBuffer, out uint RoutingInfoBufferSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINFAX_FaxGetRoutingInfoA' -Namespace Win32 -PassThru
# $api::FaxGetRoutingInfoA(FaxPortHandle, RoutingGuid, RoutingInfoBuffer, RoutingInfoBufferSize)
#uselib "WINFAX.dll"
#func global FaxGetRoutingInfoA "FaxGetRoutingInfoA" sptr, sptr, sptr, sptr
; FaxGetRoutingInfoA FaxPortHandle, RoutingGuid, varptr(RoutingInfoBuffer), varptr(RoutingInfoBufferSize)   ; 戻り値は stat
; FaxPortHandle : HANDLE -> "sptr"
; RoutingGuid : LPCSTR -> "sptr"
; RoutingInfoBuffer : BYTE** out -> "sptr"
; RoutingInfoBufferSize : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WINFAX.dll"
#cfunc global FaxGetRoutingInfoA "FaxGetRoutingInfoA" sptr, str, var, var
; res = FaxGetRoutingInfoA(FaxPortHandle, RoutingGuid, RoutingInfoBuffer, RoutingInfoBufferSize)
; FaxPortHandle : HANDLE -> "sptr"
; RoutingGuid : LPCSTR -> "str"
; RoutingInfoBuffer : BYTE** out -> "var"
; RoutingInfoBufferSize : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL FaxGetRoutingInfoA(HANDLE FaxPortHandle, LPCSTR RoutingGuid, BYTE** RoutingInfoBuffer, DWORD* RoutingInfoBufferSize)
#uselib "WINFAX.dll"
#cfunc global FaxGetRoutingInfoA "FaxGetRoutingInfoA" intptr, str, var, var
; res = FaxGetRoutingInfoA(FaxPortHandle, RoutingGuid, RoutingInfoBuffer, RoutingInfoBufferSize)
; FaxPortHandle : HANDLE -> "intptr"
; RoutingGuid : LPCSTR -> "str"
; RoutingInfoBuffer : BYTE** out -> "var"
; RoutingInfoBufferSize : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winfax = windows.NewLazySystemDLL("WINFAX.dll")
	procFaxGetRoutingInfoA = winfax.NewProc("FaxGetRoutingInfoA")
)

// FaxPortHandle (HANDLE), RoutingGuid (LPCSTR), RoutingInfoBuffer (BYTE** out), RoutingInfoBufferSize (DWORD* out)
r1, _, err := procFaxGetRoutingInfoA.Call(
	uintptr(FaxPortHandle),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(RoutingGuid))),
	uintptr(RoutingInfoBuffer),
	uintptr(RoutingInfoBufferSize),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function FaxGetRoutingInfoA(
  FaxPortHandle: THandle;   // HANDLE
  RoutingGuid: PAnsiChar;   // LPCSTR
  RoutingInfoBuffer: Pointer;   // BYTE** out
  RoutingInfoBufferSize: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'WINFAX.dll' name 'FaxGetRoutingInfoA';
result := DllCall("WINFAX\FaxGetRoutingInfoA"
    , "Ptr", FaxPortHandle   ; HANDLE
    , "AStr", RoutingGuid   ; LPCSTR
    , "Ptr", RoutingInfoBuffer   ; BYTE** out
    , "Ptr", RoutingInfoBufferSize   ; DWORD* out
    , "Int")   ; return: BOOL
●FaxGetRoutingInfoA(FaxPortHandle, RoutingGuid, RoutingInfoBuffer, RoutingInfoBufferSize) = DLL("WINFAX.dll", "bool FaxGetRoutingInfoA(void*, char*, void*, void*)")
# 呼び出し: FaxGetRoutingInfoA(FaxPortHandle, RoutingGuid, RoutingInfoBuffer, RoutingInfoBufferSize)
# FaxPortHandle : HANDLE -> "void*"
# RoutingGuid : LPCSTR -> "char*"
# RoutingInfoBuffer : BYTE** out -> "void*"
# RoutingInfoBufferSize : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。