FaxGetPortW

関数

指定したファクスポートの構成情報を取得する。

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

シグネチャ

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

BOOL FaxGetPortW(
    HANDLE FaxPortHandle,
    FAX_PORT_INFOW** PortInfo
);

パラメーター

名前	型	方向	説明
FaxPortHandle	HANDLE	in	FaxOpenPort 関数の呼び出しによって返された FAX ポートハンドルを指定します。
PortInfo	FAX_PORT_INFOW**	out	FAX_PORT_INFO 構造体を受け取るバッファーのアドレスへのポインターです。この構造体は 1 つの FAX ポートを記述します。メモリの割り当てについては、後の「解説」セクションを参照してください。

戻り値の型: BOOL

公式ドキュメント

FaxGetPort 関数は、指定された FAX ポートの情報を FAX クライアントアプリケーションに返します。(Unicode)

戻り値

型: BOOL

関数が成功すると、戻り値は 0 以外の値になります。

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

戻り値	説明
ERROR_INVALID_PARAMETER	PortInfo パラメーターまたは FaxPortHandle パラメーターの一方または両方が NULL です。
ERROR_ACCESS_DENIED	アクセスが拒否されました。FAX_PORT_QUERY アクセス権が必要です。
ERROR_NOT_ENOUGH_MEMORY	メモリの割り当て中にエラーが発生しました。

解説(Remarks)

アプリケーションは、FaxGetPort 関数を呼び出す前に、FaxOpenPort 関数を呼び出し、PORT_OPEN_QUERY アクセスレベルを指定する必要があります。

FAX 管理アプリケーションは通常、FAX サーバーに関連付けられたデバイスを照会するために FaxGetPort 関数を呼び出します。

FaxPortHandle パラメーターに指定する有効なポートハンドルを取得するには、FaxOpenPort 関数を呼び出します。

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

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

メモ

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

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

各言語での呼び出し定義

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

BOOL FaxGetPortW(
    HANDLE FaxPortHandle,
    FAX_PORT_INFOW** PortInfo
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINFAX.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool FaxGetPortW(
    IntPtr FaxPortHandle,   // HANDLE
    IntPtr PortInfo   // FAX_PORT_INFOW** out
);

<DllImport("WINFAX.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FaxGetPortW(
    FaxPortHandle As IntPtr,   ' HANDLE
    PortInfo As IntPtr   ' FAX_PORT_INFOW** out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' FaxPortHandle : HANDLE
' PortInfo : FAX_PORT_INFOW** out
Declare PtrSafe Function FaxGetPortW Lib "winfax" ( _
    ByVal FaxPortHandle As LongPtr, _
    ByVal PortInfo As LongPtr) 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

FaxGetPortW = ctypes.windll.winfax.FaxGetPortW
FaxGetPortW.restype = wintypes.BOOL
FaxGetPortW.argtypes = [
    wintypes.HANDLE,  # FaxPortHandle : HANDLE
    ctypes.c_void_p,  # PortInfo : FAX_PORT_INFOW** out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINFAX.dll')
FaxGetPortW = Fiddle::Function.new(
  lib['FaxGetPortW'],
  [
    Fiddle::TYPE_VOIDP,  # FaxPortHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # PortInfo : FAX_PORT_INFOW** out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

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

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

出力引数:

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