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

FaxSetRoutingInfoW

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

シグネチャ

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

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

パラメーター

名前方向説明
FaxPortHandleHANDLEin対象のFAXポートハンドルを指定する。
RoutingGuidLPCWSTRin設定対象のルーティングメソッドのGUID文字列(Unicode)を指定する。
RoutingInfoBufferBYTE*in設定するルーティング情報データのバッファへのポインタを指定する。
RoutingInfoBufferSizeDWORDinRoutingInfoBufferのバイトサイズを指定する。

戻り値の型: BOOL

各言語での呼び出し定義

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

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

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

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

var (
	winfax = windows.NewLazySystemDLL("WINFAX.dll")
	procFaxSetRoutingInfoW = winfax.NewProc("FaxSetRoutingInfoW")
)

// FaxPortHandle (HANDLE), RoutingGuid (LPCWSTR), RoutingInfoBuffer (BYTE*), RoutingInfoBufferSize (DWORD)
r1, _, err := procFaxSetRoutingInfoW.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 FaxSetRoutingInfoW(
  FaxPortHandle: THandle;   // HANDLE
  RoutingGuid: PWideChar;   // LPCWSTR
  RoutingInfoBuffer: Pointer;   // BYTE*
  RoutingInfoBufferSize: DWORD   // DWORD
): BOOL; stdcall;
  external 'WINFAX.dll' name 'FaxSetRoutingInfoW';
result := DllCall("WINFAX\FaxSetRoutingInfoW"
    , "Ptr", FaxPortHandle   ; HANDLE
    , "WStr", RoutingGuid   ; LPCWSTR
    , "Ptr", RoutingInfoBuffer   ; BYTE*
    , "UInt", RoutingInfoBufferSize   ; DWORD
    , "Int")   ; return: BOOL
●FaxSetRoutingInfoW(FaxPortHandle, RoutingGuid, RoutingInfoBuffer, RoutingInfoBufferSize) = DLL("WINFAX.dll", "bool FaxSetRoutingInfoW(void*, char*, void*, dword)")
# 呼び出し: FaxSetRoutingInfoW(FaxPortHandle, RoutingGuid, RoutingInfoBuffer, RoutingInfoBufferSize)
# FaxPortHandle : HANDLE -> "void*"
# RoutingGuid : LPCWSTR -> "char*"
# RoutingInfoBuffer : BYTE* -> "void*"
# RoutingInfoBufferSize : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

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

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

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

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

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

関連項目

文字セット違い