ホーム › Devices.Fax › FaxEnumRoutingMethodsA

FaxEnumRoutingMethodsA

関数

指定したポートで利用可能なルーティング方法を列挙する。

DLLWINFAX.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL FaxEnumRoutingMethodsA(
    HANDLE FaxPortHandle,
    FAX_ROUTING_METHODA** RoutingMethod,
    DWORD* MethodsReturned
);

パラメーター

名前	型	方向	説明
FaxPortHandle	HANDLE	in	FaxOpenPort 関数の呼び出しによって返されたファックスポートハンドルを指定します。
RoutingMethod	FAX_ROUTING_METHODA**	out	FAX_ROUTING_METHOD 構造体の配列を受け取るバッファーのアドレスへのポインター。各構造体には、1 つのファックスルーティング方法に関する情報が格納されます。このデータには、ルーティング方法をエクスポートする DLL の名前、ルーティング方法を識別する GUID と関数名、その方法のわかりやすい名前などが含まれます。メモリの割り当てについては、後述の「解説」セクションを参照してください。ファックスルーティング方法については、「ファックスルーティング拡張 API について」を参照してください。
MethodsReturned	DWORD*	out	FaxEnumRoutingMethods 関数が RoutingMethod パラメーターで返す FAX_ROUTING_METHOD 構造体の数を受け取る DWORD 変数へのポインター。

名前

型

方向

説明

FaxPortHandle

HANDLE

FaxOpenPort 関数の呼び出しによって返されたファックスポートハンドルを指定します。

RoutingMethod

FAX_ROUTING_METHODA**

out

FAX_ROUTING_METHOD 構造体の配列を受け取るバッファーのアドレスへのポインター。各構造体には、1 つのファックスルーティング方法に関する情報が格納されます。このデータには、ルーティング方法をエクスポートする DLL の名前、ルーティング方法を識別する GUID と関数名、その方法のわかりやすい名前などが含まれます。

メモリの割り当てについては、後述の「解説」セクションを参照してください。ファックスルーティング方法については、「ファックスルーティング拡張 API について」を参照してください。

MethodsReturned

DWORD*

out

FaxEnumRoutingMethods 関数が RoutingMethod パラメーターで返す FAX_ROUTING_METHOD 構造体の数を受け取る DWORD 変数へのポインター。

戻り値の型: BOOL

公式ドキュメント

FaxEnumRoutingMethods 関数は、特定のファックスデバイスに対するすべてのファックスルーティング方法を列挙します。この関数は、各ルーティング方法に関する情報をファックスクライアントアプリケーションに返します。(ANSI)

戻り値

型: BOOL

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError を呼び出します。GetLastError は次のいずれかのエラーを返すことがあります。

戻り値	説明
ERROR_ACCESS_DENIED	アクセスが拒否されました。FAX_PORT_QUERY アクセス権が必要です。
ERROR_INVALID_PARAMETER	MethodsReturned、RoutingMethod、FaxPortHandle の各パラメーターのいずれか、またはすべてが NULL です。
ERROR_NOT_ENOUGH_MEMORY	メモリの割り当て中にエラーが発生しました。

解説(Remarks)

ファックス管理アプリケーションは、特定のデバイスに関連付けられたファックスルーティング方法を照会するために、通常 FaxEnumRoutingMethods 関数を呼び出します。特定のファックスルーティング方法のルーティング情報を変更するには、FaxSetRoutingInfo 関数を呼び出します。

FaxEnumGlobalRoutingInfo 関数は、ルーティングの優先順位など、ファックスサーバー全体に適用されるルーティング情報を取得します。アプリケーションは、FaxSetGlobalRoutingInfo 関数を呼び出すことで、グローバルなデータを変更できます。

FaxEnumRoutingMethods 関数は、RoutingMethod パラメーターが指す FAX_ROUTING_METHOD のバッファー配列に必要なメモリを割り当てます。アプリケーションは、このパラメーターに関連付けられたリソースを解放するために、FaxFreeBuffer 関数を呼び出す必要があります。

詳細については、「ファックスサーバーの構成管理」および「ファックスリソースの解放」を参照してください。

メモ

winfax.h ヘッダーは、UNICODE プリプロセッサ定数の定義に応じてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして、FaxEnumRoutingMethods を定義しています。エンコードに依存しないこのエイリアスを、エンコードに依存するコードと混在させて使用すると、不一致が生じてコンパイルエラーや実行時エラーの原因となることがあります。詳細については、関数プロトタイプの規則を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

BOOL FaxEnumRoutingMethodsA(
    HANDLE FaxPortHandle,
    FAX_ROUTING_METHODA** RoutingMethod,
    DWORD* MethodsReturned
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINFAX.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool FaxEnumRoutingMethodsA(
    IntPtr FaxPortHandle,   // HANDLE
    IntPtr RoutingMethod,   // FAX_ROUTING_METHODA** out
    out uint MethodsReturned   // DWORD* out
);

<DllImport("WINFAX.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FaxEnumRoutingMethodsA(
    FaxPortHandle As IntPtr,   ' HANDLE
    RoutingMethod As IntPtr,   ' FAX_ROUTING_METHODA** out
    <Out> ByRef MethodsReturned As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' FaxPortHandle : HANDLE
' RoutingMethod : FAX_ROUTING_METHODA** out
' MethodsReturned : DWORD* out
Declare PtrSafe Function FaxEnumRoutingMethodsA Lib "winfax" ( _
    ByVal FaxPortHandle As LongPtr, _
    ByVal RoutingMethod As LongPtr, _
    ByRef MethodsReturned As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

FaxEnumRoutingMethodsA = ctypes.windll.winfax.FaxEnumRoutingMethodsA
FaxEnumRoutingMethodsA.restype = wintypes.BOOL
FaxEnumRoutingMethodsA.argtypes = [
    wintypes.HANDLE,  # FaxPortHandle : HANDLE
    ctypes.c_void_p,  # RoutingMethod : FAX_ROUTING_METHODA** out
    ctypes.POINTER(wintypes.DWORD),  # MethodsReturned : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINFAX.dll')
FaxEnumRoutingMethodsA = Fiddle::Function.new(
  lib['FaxEnumRoutingMethodsA'],
  [
    Fiddle::TYPE_VOIDP,  # FaxPortHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # RoutingMethod : FAX_ROUTING_METHODA** out
    Fiddle::TYPE_VOIDP,  # MethodsReturned : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "winfax")]
extern "system" {
    fn FaxEnumRoutingMethodsA(
        FaxPortHandle: *mut core::ffi::c_void,  // HANDLE
        RoutingMethod: *mut *mut FAX_ROUTING_METHODA,  // FAX_ROUTING_METHODA** out
        MethodsReturned: *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 FaxEnumRoutingMethodsA(IntPtr FaxPortHandle, IntPtr RoutingMethod, out uint MethodsReturned);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINFAX_FaxEnumRoutingMethodsA' -Namespace Win32 -PassThru
# $api::FaxEnumRoutingMethodsA(FaxPortHandle, RoutingMethod, MethodsReturned)

#uselib "WINFAX.dll"
#func global FaxEnumRoutingMethodsA "FaxEnumRoutingMethodsA" sptr, sptr, sptr
; FaxEnumRoutingMethodsA FaxPortHandle, varptr(RoutingMethod), varptr(MethodsReturned)   ; 戻り値は stat
; FaxPortHandle : HANDLE -> "sptr"
; RoutingMethod : FAX_ROUTING_METHODA** out -> "sptr"
; MethodsReturned : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WINFAX.dll"
#cfunc global FaxEnumRoutingMethodsA "FaxEnumRoutingMethodsA" sptr, var, var
; res = FaxEnumRoutingMethodsA(FaxPortHandle, RoutingMethod, MethodsReturned)
; FaxPortHandle : HANDLE -> "sptr"
; RoutingMethod : FAX_ROUTING_METHODA** out -> "var"
; MethodsReturned : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WINFAX.dll"
#cfunc global FaxEnumRoutingMethodsA "FaxEnumRoutingMethodsA" sptr, sptr, sptr
; res = FaxEnumRoutingMethodsA(FaxPortHandle, varptr(RoutingMethod), varptr(MethodsReturned))
; FaxPortHandle : HANDLE -> "sptr"
; RoutingMethod : FAX_ROUTING_METHODA** out -> "sptr"
; MethodsReturned : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。