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

FaxOpenPort

関数
指定したFAXデバイスのポートを開く。
DLLWINFAX.dll呼出規約winapi

シグネチャ

// WINFAX.dll
#include <windows.h>

BOOL FaxOpenPort(
    HANDLE FaxHandle,
    DWORD DeviceId,
    DWORD Flags,
    HANDLE* FaxPortHandle
);

パラメーター

名前方向説明
FaxHandleHANDLEinFAXサーバー接続のハンドルを指定する。
DeviceIdDWORDin開く対象のFAXデバイス(ポート)の識別子を指定する。
FlagsDWORDinポートのアクセス方法を指定するフラグ。PORT_OPEN_QUERYやPORT_OPEN_MODIFY等を組み合わせる。
FaxPortHandleHANDLE*out開かれたFAXポートのハンドルを受け取るポインタを指定する。出力専用。

戻り値の型: BOOL

各言語での呼び出し定義

// WINFAX.dll
#include <windows.h>

BOOL FaxOpenPort(
    HANDLE FaxHandle,
    DWORD DeviceId,
    DWORD Flags,
    HANDLE* FaxPortHandle
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINFAX.dll", ExactSpelling = true)]
static extern bool FaxOpenPort(
    IntPtr FaxHandle,   // HANDLE
    uint DeviceId,   // DWORD
    uint Flags,   // DWORD
    IntPtr FaxPortHandle   // HANDLE* out
);
<DllImport("WINFAX.dll", ExactSpelling:=True)>
Public Shared Function FaxOpenPort(
    FaxHandle As IntPtr,   ' HANDLE
    DeviceId As UInteger,   ' DWORD
    Flags As UInteger,   ' DWORD
    FaxPortHandle As IntPtr   ' HANDLE* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' FaxHandle : HANDLE
' DeviceId : DWORD
' Flags : DWORD
' FaxPortHandle : HANDLE* out
Declare PtrSafe Function FaxOpenPort Lib "winfax" ( _
    ByVal FaxHandle As LongPtr, _
    ByVal DeviceId As Long, _
    ByVal Flags As Long, _
    ByVal FaxPortHandle As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

FaxOpenPort = ctypes.windll.winfax.FaxOpenPort
FaxOpenPort.restype = wintypes.BOOL
FaxOpenPort.argtypes = [
    wintypes.HANDLE,  # FaxHandle : HANDLE
    wintypes.DWORD,  # DeviceId : DWORD
    wintypes.DWORD,  # Flags : DWORD
    ctypes.c_void_p,  # FaxPortHandle : HANDLE* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINFAX.dll')
FaxOpenPort = Fiddle::Function.new(
  lib['FaxOpenPort'],
  [
    Fiddle::TYPE_VOIDP,  # FaxHandle : HANDLE
    -Fiddle::TYPE_INT,  # DeviceId : DWORD
    -Fiddle::TYPE_INT,  # Flags : DWORD
    Fiddle::TYPE_VOIDP,  # FaxPortHandle : HANDLE* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "winfax")]
extern "system" {
    fn FaxOpenPort(
        FaxHandle: *mut core::ffi::c_void,  // HANDLE
        DeviceId: u32,  // DWORD
        Flags: u32,  // DWORD
        FaxPortHandle: *mut *mut core::ffi::c_void  // HANDLE* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINFAX.dll")]
public static extern bool FaxOpenPort(IntPtr FaxHandle, uint DeviceId, uint Flags, IntPtr FaxPortHandle);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINFAX_FaxOpenPort' -Namespace Win32 -PassThru
# $api::FaxOpenPort(FaxHandle, DeviceId, Flags, FaxPortHandle)
#uselib "WINFAX.dll"
#func global FaxOpenPort "FaxOpenPort" sptr, sptr, sptr, sptr
; FaxOpenPort FaxHandle, DeviceId, Flags, FaxPortHandle   ; 戻り値は stat
; FaxHandle : HANDLE -> "sptr"
; DeviceId : DWORD -> "sptr"
; Flags : DWORD -> "sptr"
; FaxPortHandle : HANDLE* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WINFAX.dll"
#cfunc global FaxOpenPort "FaxOpenPort" sptr, int, int, sptr
; res = FaxOpenPort(FaxHandle, DeviceId, Flags, FaxPortHandle)
; FaxHandle : HANDLE -> "sptr"
; DeviceId : DWORD -> "int"
; Flags : DWORD -> "int"
; FaxPortHandle : HANDLE* out -> "sptr"
; BOOL FaxOpenPort(HANDLE FaxHandle, DWORD DeviceId, DWORD Flags, HANDLE* FaxPortHandle)
#uselib "WINFAX.dll"
#cfunc global FaxOpenPort "FaxOpenPort" intptr, int, int, intptr
; res = FaxOpenPort(FaxHandle, DeviceId, Flags, FaxPortHandle)
; FaxHandle : HANDLE -> "intptr"
; DeviceId : DWORD -> "int"
; Flags : DWORD -> "int"
; FaxPortHandle : HANDLE* out -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winfax = windows.NewLazySystemDLL("WINFAX.dll")
	procFaxOpenPort = winfax.NewProc("FaxOpenPort")
)

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

extern "winfax" fn FaxOpenPort(
    FaxHandle: ?*anyopaque, // HANDLE
    DeviceId: u32, // DWORD
    Flags: u32, // DWORD
    FaxPortHandle: ?*anyopaque // HANDLE* out
) callconv(std.os.windows.WINAPI) i32;
proc FaxOpenPort(
    FaxHandle: pointer,  # HANDLE
    DeviceId: uint32,  # DWORD
    Flags: uint32,  # DWORD
    FaxPortHandle: pointer  # HANDLE* out
): int32 {.importc: "FaxOpenPort", stdcall, dynlib: "WINFAX.dll".}
pragma(lib, "winfax");
extern(Windows)
int FaxOpenPort(
    void* FaxHandle,   // HANDLE
    uint DeviceId,   // DWORD
    uint Flags,   // DWORD
    void* FaxPortHandle   // HANDLE* out
);
ccall((:FaxOpenPort, "WINFAX.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt32, UInt32, Ptr{Cvoid}),
      FaxHandle, DeviceId, Flags, FaxPortHandle)
# FaxHandle : HANDLE -> Ptr{Cvoid}
# DeviceId : DWORD -> UInt32
# Flags : DWORD -> UInt32
# FaxPortHandle : HANDLE* out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t FaxOpenPort(
    void* FaxHandle,
    uint32_t DeviceId,
    uint32_t Flags,
    void* FaxPortHandle);
]]
local winfax = ffi.load("winfax")
-- winfax.FaxOpenPort(FaxHandle, DeviceId, Flags, FaxPortHandle)
-- FaxHandle : HANDLE
-- DeviceId : DWORD
-- Flags : DWORD
-- FaxPortHandle : HANDLE* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WINFAX.dll');
const FaxOpenPort = lib.func('__stdcall', 'FaxOpenPort', 'int32_t', ['void *', 'uint32_t', 'uint32_t', 'void *']);
// FaxOpenPort(FaxHandle, DeviceId, Flags, FaxPortHandle)
// FaxHandle : HANDLE -> 'void *'
// DeviceId : DWORD -> 'uint32_t'
// Flags : DWORD -> 'uint32_t'
// FaxPortHandle : HANDLE* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WINFAX.dll", {
  FaxOpenPort: { parameters: ["pointer", "u32", "u32", "pointer"], result: "i32" },
});
// lib.symbols.FaxOpenPort(FaxHandle, DeviceId, Flags, FaxPortHandle)
// FaxHandle : HANDLE -> "pointer"
// DeviceId : DWORD -> "u32"
// Flags : DWORD -> "u32"
// FaxPortHandle : HANDLE* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t FaxOpenPort(
    void* FaxHandle,
    uint32_t DeviceId,
    uint32_t Flags,
    void* FaxPortHandle);
C, "WINFAX.dll");
// $ffi->FaxOpenPort(FaxHandle, DeviceId, Flags, FaxPortHandle);
// FaxHandle : HANDLE
// DeviceId : DWORD
// Flags : DWORD
// FaxPortHandle : HANDLE* out
// 構造体/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);
    boolean FaxOpenPort(
        Pointer FaxHandle,   // HANDLE
        int DeviceId,   // DWORD
        int Flags,   // DWORD
        Pointer FaxPortHandle   // HANDLE* out
    );
}
@[Link("winfax")]
lib LibWINFAX
  fun FaxOpenPort = FaxOpenPort(
    FaxHandle : Void*,   # HANDLE
    DeviceId : UInt32,   # DWORD
    Flags : UInt32,   # DWORD
    FaxPortHandle : Void*   # HANDLE* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef FaxOpenPortNative = Int32 Function(Pointer<Void>, Uint32, Uint32, Pointer<Void>);
typedef FaxOpenPortDart = int Function(Pointer<Void>, int, int, Pointer<Void>);
final FaxOpenPort = DynamicLibrary.open('WINFAX.dll')
    .lookupFunction<FaxOpenPortNative, FaxOpenPortDart>('FaxOpenPort');
// FaxHandle : HANDLE -> Pointer<Void>
// DeviceId : DWORD -> Uint32
// Flags : DWORD -> Uint32
// FaxPortHandle : HANDLE* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FaxOpenPort(
  FaxHandle: THandle;   // HANDLE
  DeviceId: DWORD;   // DWORD
  Flags: DWORD;   // DWORD
  FaxPortHandle: Pointer   // HANDLE* out
): BOOL; stdcall;
  external 'WINFAX.dll' name 'FaxOpenPort';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "FaxOpenPort"
  c_FaxOpenPort :: Ptr () -> Word32 -> Word32 -> Ptr () -> IO CInt
-- FaxHandle : HANDLE -> Ptr ()
-- DeviceId : DWORD -> Word32
-- Flags : DWORD -> Word32
-- FaxPortHandle : HANDLE* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let faxopenport =
  foreign "FaxOpenPort"
    ((ptr void) @-> uint32_t @-> uint32_t @-> (ptr void) @-> returning int32_t)
(* FaxHandle : HANDLE -> (ptr void) *)
(* DeviceId : DWORD -> uint32_t *)
(* Flags : DWORD -> uint32_t *)
(* FaxPortHandle : HANDLE* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winfax (t "WINFAX.dll"))
(cffi:use-foreign-library winfax)

(cffi:defcfun ("FaxOpenPort" fax-open-port :convention :stdcall) :int32
  (fax-handle :pointer)   ; HANDLE
  (device-id :uint32)   ; DWORD
  (flags :uint32)   ; DWORD
  (fax-port-handle :pointer))   ; HANDLE* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FaxOpenPort = Win32::API::More->new('WINFAX',
    'BOOL FaxOpenPort(HANDLE FaxHandle, DWORD DeviceId, DWORD Flags, HANDLE FaxPortHandle)');
# my $ret = $FaxOpenPort->Call($FaxHandle, $DeviceId, $Flags, $FaxPortHandle);
# FaxHandle : HANDLE -> HANDLE
# DeviceId : DWORD -> DWORD
# Flags : DWORD -> DWORD
# FaxPortHandle : HANDLE* out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。