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

FaxEnableRoutingMethodA

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

シグネチャ

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

BOOL FaxEnableRoutingMethodA(
    HANDLE FaxPortHandle,
    LPCSTR RoutingGuid,
    BOOL Enabled
);

パラメーター

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

戻り値の型: BOOL

各言語での呼び出し定義

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

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

FaxEnableRoutingMethodA = ctypes.windll.winfax.FaxEnableRoutingMethodA
FaxEnableRoutingMethodA.restype = wintypes.BOOL
FaxEnableRoutingMethodA.argtypes = [
    wintypes.HANDLE,  # FaxPortHandle : HANDLE
    wintypes.LPCSTR,  # RoutingGuid : LPCSTR
    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')
FaxEnableRoutingMethodA = Fiddle::Function.new(
  lib['FaxEnableRoutingMethodA'],
  [
    Fiddle::TYPE_VOIDP,  # FaxPortHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # RoutingGuid : LPCSTR
    Fiddle::TYPE_INT,  # Enabled : BOOL
  ],
  Fiddle::TYPE_INT)
#[link(name = "winfax")]
extern "system" {
    fn FaxEnableRoutingMethodA(
        FaxPortHandle: *mut core::ffi::c_void,  // HANDLE
        RoutingGuid: *const u8,  // LPCSTR
        Enabled: i32  // BOOL
    ) -> 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 FaxEnableRoutingMethodA(IntPtr FaxPortHandle, [MarshalAs(UnmanagedType.LPStr)] string RoutingGuid, bool Enabled);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINFAX_FaxEnableRoutingMethodA' -Namespace Win32 -PassThru
# $api::FaxEnableRoutingMethodA(FaxPortHandle, RoutingGuid, Enabled)
#uselib "WINFAX.dll"
#func global FaxEnableRoutingMethodA "FaxEnableRoutingMethodA" sptr, sptr, sptr
; FaxEnableRoutingMethodA FaxPortHandle, RoutingGuid, Enabled   ; 戻り値は stat
; FaxPortHandle : HANDLE -> "sptr"
; RoutingGuid : LPCSTR -> "sptr"
; Enabled : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WINFAX.dll"
#cfunc global FaxEnableRoutingMethodA "FaxEnableRoutingMethodA" sptr, str, int
; res = FaxEnableRoutingMethodA(FaxPortHandle, RoutingGuid, Enabled)
; FaxPortHandle : HANDLE -> "sptr"
; RoutingGuid : LPCSTR -> "str"
; Enabled : BOOL -> "int"
; BOOL FaxEnableRoutingMethodA(HANDLE FaxPortHandle, LPCSTR RoutingGuid, BOOL Enabled)
#uselib "WINFAX.dll"
#cfunc global FaxEnableRoutingMethodA "FaxEnableRoutingMethodA" intptr, str, int
; res = FaxEnableRoutingMethodA(FaxPortHandle, RoutingGuid, Enabled)
; FaxPortHandle : HANDLE -> "intptr"
; RoutingGuid : LPCSTR -> "str"
; Enabled : BOOL -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winfax = windows.NewLazySystemDLL("WINFAX.dll")
	procFaxEnableRoutingMethodA = winfax.NewProc("FaxEnableRoutingMethodA")
)

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

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

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

let faxenableroutingmethoda =
  foreign "FaxEnableRoutingMethodA"
    ((ptr void) @-> string @-> int32_t @-> returning int32_t)
(* FaxPortHandle : HANDLE -> (ptr void) *)
(* RoutingGuid : LPCSTR -> string *)
(* 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 ("FaxEnableRoutingMethodA" fax-enable-routing-method-a :convention :stdcall) :int32
  (fax-port-handle :pointer)   ; HANDLE
  (routing-guid :string)   ; LPCSTR
  (enabled :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FaxEnableRoutingMethodA = Win32::API::More->new('WINFAX',
    'BOOL FaxEnableRoutingMethodA(HANDLE FaxPortHandle, LPCSTR RoutingGuid, BOOL Enabled)');
# my $ret = $FaxEnableRoutingMethodA->Call($FaxPortHandle, $RoutingGuid, $Enabled);
# FaxPortHandle : HANDLE -> HANDLE
# RoutingGuid : LPCSTR -> LPCSTR
# Enabled : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い