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
);

パラメーター

名前	型	方向	説明
FaxPortHandle	HANDLE	in	FaxOpenPort 関数の呼び出しによって返されたファックスポートハンドルを指定します。
RoutingGuid	LPCSTR	in	対象のファックスルーティングメソッドを一意に識別する GUID を指定する、定数の null 終端文字列へのポインターです。ファックスルーティングメソッドについては、About the Fax Routing Extension API を参照してください。ルーティングメソッドと GUID の関係については、Fax Routing Methods を参照してください。
RoutingInfoBuffer	BYTE**	out	ファックスルーティング情報を受け取るバッファーのアドレスへのポインターです。
RoutingInfoBufferSize	DWORD*	out	RoutingInfoBuffer パラメーターが指すバッファーのサイズ (バイト単位) を受け取る DWORD 変数へのポインターです。

戻り値の型: BOOL

公式ドキュメント

FaxGetRoutingInfo 関数は、特定のファックスデバイスに関連付けられたファックスルーティングメソッドのルーティング情報を、ファックスクライアントアプリケーションに返します。(ANSI)

戻り値

種類: BOOL

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

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

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

解説(Remarks)

FaxGetRoutingInfo 関数は通常、指定されたファックスルーティングメソッドを管理する Microsoft 管理コンソール (MMC) スナップインコンポーネントであるファックスサービス管理アプリケーションが呼び出します。これは、ルーティングデータの形式がファックスクライアントアプリケーションからは利用できないためです。ルーティングデータは、エクスポートされたファックスルーティングメソッドとファックスサービス管理アプリケーションにのみ関係します。

特定のファックスルーティングメソッドを管理するアプリケーションは、FaxGetRoutingInfo 関数を呼び出して、指定したファックスデバイス上のそのメソッドのルーティング情報を変更できます。デバイスに関連付けられたすべてのファックスルーティングメソッドを列挙するには、FaxEnumRoutingMethods 関数を呼び出します。

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

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

詳細については、Managing Fax Routing Data および Freeing Fax Resources を参照してください。

メモ

winfax.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして FaxGetRoutingInfo を定義します。エンコーディング中立のエイリアスと、エンコーディング中立でないコードを混在させて使用すると、不一致が生じてコンパイルエラーや実行時エラーの原因となることがあります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 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 方式にも切替可。#uselib "WINFAX.dll"
#cfunc global FaxGetRoutingInfoA "FaxGetRoutingInfoA" sptr, str, sptr, sptr
; res = FaxGetRoutingInfoA(FaxPortHandle, RoutingGuid, varptr(RoutingInfoBuffer), varptr(RoutingInfoBufferSize))
; FaxPortHandle : HANDLE -> "sptr"
; RoutingGuid : LPCSTR -> "str"
; RoutingInfoBuffer : BYTE** out -> "sptr"
; RoutingInfoBufferSize : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。