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

FaxEnableRoutingMethodW

関数
指定したポートのルーティング方法を有効または無効にする。
DLLWINFAX.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL FaxEnableRoutingMethodW(
    HANDLE FaxPortHandle,
    LPCWSTR RoutingGuid,
    BOOL Enabled
);

パラメーター

名前方向説明
FaxPortHandleHANDLEin対象のFAXポートハンドルを指定する。
RoutingGuidLPCWSTRin有効/無効を切り替えるルーティングメソッドのGUID文字列(Unicode)を指定する。
EnabledBOOLinルーティングメソッドを有効化するかをBOOLで指定する。TRUEで有効、FALSEで無効。

戻り値の型: BOOL

各言語での呼び出し定義

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

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

FaxEnableRoutingMethodW = ctypes.windll.winfax.FaxEnableRoutingMethodW
FaxEnableRoutingMethodW.restype = wintypes.BOOL
FaxEnableRoutingMethodW.argtypes = [
    wintypes.HANDLE,  # FaxPortHandle : HANDLE
    wintypes.LPCWSTR,  # RoutingGuid : LPCWSTR
    wintypes.BOOL,  # Enabled : BOOL
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINFAX.dll')
FaxEnableRoutingMethodW = Fiddle::Function.new(
  lib['FaxEnableRoutingMethodW'],
  [
    Fiddle::TYPE_VOIDP,  # FaxPortHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # RoutingGuid : LPCWSTR
    Fiddle::TYPE_INT,  # Enabled : BOOL
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "winfax")]
extern "system" {
    fn FaxEnableRoutingMethodW(
        FaxPortHandle: *mut core::ffi::c_void,  // HANDLE
        RoutingGuid: *const u16,  // LPCWSTR
        Enabled: i32  // BOOL
    ) -> 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 FaxEnableRoutingMethodW(IntPtr FaxPortHandle, [MarshalAs(UnmanagedType.LPWStr)] string RoutingGuid, bool Enabled);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINFAX_FaxEnableRoutingMethodW' -Namespace Win32 -PassThru
# $api::FaxEnableRoutingMethodW(FaxPortHandle, RoutingGuid, Enabled)
#uselib "WINFAX.dll"
#func global FaxEnableRoutingMethodW "FaxEnableRoutingMethodW" wptr, wptr, wptr
; FaxEnableRoutingMethodW FaxPortHandle, RoutingGuid, Enabled   ; 戻り値は stat
; FaxPortHandle : HANDLE -> "wptr"
; RoutingGuid : LPCWSTR -> "wptr"
; Enabled : BOOL -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WINFAX.dll"
#cfunc global FaxEnableRoutingMethodW "FaxEnableRoutingMethodW" sptr, wstr, int
; res = FaxEnableRoutingMethodW(FaxPortHandle, RoutingGuid, Enabled)
; FaxPortHandle : HANDLE -> "sptr"
; RoutingGuid : LPCWSTR -> "wstr"
; Enabled : BOOL -> "int"
; BOOL FaxEnableRoutingMethodW(HANDLE FaxPortHandle, LPCWSTR RoutingGuid, BOOL Enabled)
#uselib "WINFAX.dll"
#cfunc global FaxEnableRoutingMethodW "FaxEnableRoutingMethodW" intptr, wstr, int
; res = FaxEnableRoutingMethodW(FaxPortHandle, RoutingGuid, Enabled)
; FaxPortHandle : HANDLE -> "intptr"
; RoutingGuid : LPCWSTR -> "wstr"
; Enabled : BOOL -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winfax = windows.NewLazySystemDLL("WINFAX.dll")
	procFaxEnableRoutingMethodW = winfax.NewProc("FaxEnableRoutingMethodW")
)

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

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

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

foreign import stdcall safe "FaxEnableRoutingMethodW"
  c_FaxEnableRoutingMethodW :: Ptr () -> CWString -> CInt -> IO CInt
-- FaxPortHandle : HANDLE -> Ptr ()
-- RoutingGuid : LPCWSTR -> CWString
-- Enabled : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

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

関連項目

文字セット違い