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対象のFAXポートハンドルを指定する。
RoutingGuidLPCSTRin情報を取得するルーティングメソッドのGUID文字列(ANSI)を指定する。
RoutingInfoBufferBYTE**outルーティング情報データを受け取るバッファポインタを返すポインタ。FaxFreeBufferで解放する。
RoutingInfoBufferSizeDWORD*out返されたデータのバイトサイズを受け取るDWORDへのポインタを指定する。出力専用。

戻り値の型: 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 <MarshalAs(UnmanagedType.Bool)> 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)。
const std = @import("std");

extern "winfax" fn FaxGetRoutingInfoA(
    FaxPortHandle: ?*anyopaque, // HANDLE
    RoutingGuid: [*c]const u8, // LPCSTR
    RoutingInfoBuffer: [*c][*c]u8, // BYTE** out
    RoutingInfoBufferSize: [*c]u32 // DWORD* out
) callconv(std.os.windows.WINAPI) i32;
proc FaxGetRoutingInfoA(
    FaxPortHandle: pointer,  # HANDLE
    RoutingGuid: cstring,  # LPCSTR
    RoutingInfoBuffer: ptr uint8,  # BYTE** out
    RoutingInfoBufferSize: ptr uint32  # DWORD* out
): int32 {.importc: "FaxGetRoutingInfoA", stdcall, dynlib: "WINFAX.dll".}
pragma(lib, "winfax");
extern(Windows)
int FaxGetRoutingInfoA(
    void* FaxPortHandle,   // HANDLE
    const(char)* RoutingGuid,   // LPCSTR
    ubyte** RoutingInfoBuffer,   // BYTE** out
    uint* RoutingInfoBufferSize   // DWORD* out
);
ccall((:FaxGetRoutingInfoA, "WINFAX.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Cstring, Ptr{UInt8}, Ptr{UInt32}),
      FaxPortHandle, RoutingGuid, RoutingInfoBuffer, RoutingInfoBufferSize)
# FaxPortHandle : HANDLE -> Ptr{Cvoid}
# RoutingGuid : LPCSTR -> Cstring
# RoutingInfoBuffer : BYTE** out -> Ptr{UInt8}
# RoutingInfoBufferSize : DWORD* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t FaxGetRoutingInfoA(
    void* FaxPortHandle,
    const char* RoutingGuid,
    uint8_t** RoutingInfoBuffer,
    uint32_t* RoutingInfoBufferSize);
]]
local winfax = ffi.load("winfax")
-- winfax.FaxGetRoutingInfoA(FaxPortHandle, RoutingGuid, RoutingInfoBuffer, RoutingInfoBufferSize)
-- FaxPortHandle : HANDLE
-- RoutingGuid : LPCSTR
-- RoutingInfoBuffer : BYTE** out
-- RoutingInfoBufferSize : DWORD* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WINFAX.dll');
const FaxGetRoutingInfoA = lib.func('__stdcall', 'FaxGetRoutingInfoA', 'int32_t', ['void *', 'str', 'uint8_t *', 'uint32_t *']);
// FaxGetRoutingInfoA(FaxPortHandle, RoutingGuid, RoutingInfoBuffer, RoutingInfoBufferSize)
// FaxPortHandle : HANDLE -> 'void *'
// RoutingGuid : LPCSTR -> 'str'
// RoutingInfoBuffer : BYTE** out -> 'uint8_t *'
// RoutingInfoBufferSize : DWORD* out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WINFAX.dll", {
  FaxGetRoutingInfoA: { parameters: ["pointer", "buffer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.FaxGetRoutingInfoA(FaxPortHandle, RoutingGuid, RoutingInfoBuffer, RoutingInfoBufferSize)
// FaxPortHandle : HANDLE -> "pointer"
// RoutingGuid : LPCSTR -> "buffer"
// RoutingInfoBuffer : BYTE** out -> "pointer"
// RoutingInfoBufferSize : DWORD* out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t FaxGetRoutingInfoA(
    void* FaxPortHandle,
    const char* RoutingGuid,
    uint8_t** RoutingInfoBuffer,
    uint32_t* RoutingInfoBufferSize);
C, "WINFAX.dll");
// $ffi->FaxGetRoutingInfoA(FaxPortHandle, RoutingGuid, RoutingInfoBuffer, RoutingInfoBufferSize);
// FaxPortHandle : HANDLE
// RoutingGuid : LPCSTR
// 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.ASCII_OPTIONS);
    boolean FaxGetRoutingInfoA(
        Pointer FaxPortHandle,   // HANDLE
        String RoutingGuid,   // LPCSTR
        Pointer RoutingInfoBuffer,   // BYTE** out
        IntByReference RoutingInfoBufferSize   // DWORD* out
    );
}
@[Link("winfax")]
lib LibWINFAX
  fun FaxGetRoutingInfoA = FaxGetRoutingInfoA(
    FaxPortHandle : Void*,   # HANDLE
    RoutingGuid : UInt8*,   # LPCSTR
    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 FaxGetRoutingInfoANative = Int32 Function(Pointer<Void>, Pointer<Utf8>, Pointer<Uint8>, Pointer<Uint32>);
typedef FaxGetRoutingInfoADart = int Function(Pointer<Void>, Pointer<Utf8>, Pointer<Uint8>, Pointer<Uint32>);
final FaxGetRoutingInfoA = DynamicLibrary.open('WINFAX.dll')
    .lookupFunction<FaxGetRoutingInfoANative, FaxGetRoutingInfoADart>('FaxGetRoutingInfoA');
// FaxPortHandle : HANDLE -> Pointer<Void>
// RoutingGuid : LPCSTR -> Pointer<Utf8>
// RoutingInfoBuffer : BYTE** out -> Pointer<Uint8>
// RoutingInfoBufferSize : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FaxGetRoutingInfoA(
  FaxPortHandle: THandle;   // HANDLE
  RoutingGuid: PAnsiChar;   // LPCSTR
  RoutingInfoBuffer: Pointer;   // BYTE** out
  RoutingInfoBufferSize: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'WINFAX.dll' name 'FaxGetRoutingInfoA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let faxgetroutinginfoa =
  foreign "FaxGetRoutingInfoA"
    ((ptr void) @-> string @-> (ptr uint8_t) @-> (ptr uint32_t) @-> returning int32_t)
(* FaxPortHandle : HANDLE -> (ptr void) *)
(* RoutingGuid : LPCSTR -> string *)
(* 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 ("FaxGetRoutingInfoA" fax-get-routing-info-a :convention :stdcall) :int32
  (fax-port-handle :pointer)   ; HANDLE
  (routing-guid :string)   ; LPCSTR
  (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 $FaxGetRoutingInfoA = Win32::API::More->new('WINFAX',
    'BOOL FaxGetRoutingInfoA(HANDLE FaxPortHandle, LPCSTR RoutingGuid, LPVOID RoutingInfoBuffer, LPVOID RoutingInfoBufferSize)');
# my $ret = $FaxGetRoutingInfoA->Call($FaxPortHandle, $RoutingGuid, $RoutingInfoBuffer, $RoutingInfoBufferSize);
# FaxPortHandle : HANDLE -> HANDLE
# RoutingGuid : LPCSTR -> LPCSTR
# RoutingInfoBuffer : BYTE** out -> LPVOID
# RoutingInfoBufferSize : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い