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

FaxSetPortA

関数
指定したファクスポートの構成情報を変更する。
DLLWINFAX.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL FaxSetPortA(
    HANDLE FaxPortHandle,
    const FAX_PORT_INFOA* PortInfo
);

パラメーター

名前方向説明
FaxPortHandleHANDLEin設定対象のFAXポートハンドルを指定する。
PortInfoFAX_PORT_INFOA*in設定するポート情報(FAX_PORT_INFOA)へのポインタを指定する。

戻り値の型: BOOL

各言語での呼び出し定義

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

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

FaxSetPortA = ctypes.windll.winfax.FaxSetPortA
FaxSetPortA.restype = wintypes.BOOL
FaxSetPortA.argtypes = [
    wintypes.HANDLE,  # FaxPortHandle : HANDLE
    ctypes.c_void_p,  # PortInfo : FAX_PORT_INFOA*
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINFAX.dll')
FaxSetPortA = Fiddle::Function.new(
  lib['FaxSetPortA'],
  [
    Fiddle::TYPE_VOIDP,  # FaxPortHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # PortInfo : FAX_PORT_INFOA*
  ],
  Fiddle::TYPE_INT)
#[link(name = "winfax")]
extern "system" {
    fn FaxSetPortA(
        FaxPortHandle: *mut core::ffi::c_void,  // HANDLE
        PortInfo: *const FAX_PORT_INFOA  // FAX_PORT_INFOA*
    ) -> 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 FaxSetPortA(IntPtr FaxPortHandle, IntPtr PortInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINFAX_FaxSetPortA' -Namespace Win32 -PassThru
# $api::FaxSetPortA(FaxPortHandle, PortInfo)
#uselib "WINFAX.dll"
#func global FaxSetPortA "FaxSetPortA" sptr, sptr
; FaxSetPortA FaxPortHandle, varptr(PortInfo)   ; 戻り値は stat
; FaxPortHandle : HANDLE -> "sptr"
; PortInfo : FAX_PORT_INFOA* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WINFAX.dll"
#cfunc global FaxSetPortA "FaxSetPortA" sptr, var
; res = FaxSetPortA(FaxPortHandle, PortInfo)
; FaxPortHandle : HANDLE -> "sptr"
; PortInfo : FAX_PORT_INFOA* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL FaxSetPortA(HANDLE FaxPortHandle, FAX_PORT_INFOA* PortInfo)
#uselib "WINFAX.dll"
#cfunc global FaxSetPortA "FaxSetPortA" intptr, var
; res = FaxSetPortA(FaxPortHandle, PortInfo)
; FaxPortHandle : HANDLE -> "intptr"
; PortInfo : FAX_PORT_INFOA* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winfax = windows.NewLazySystemDLL("WINFAX.dll")
	procFaxSetPortA = winfax.NewProc("FaxSetPortA")
)

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

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

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

foreign import stdcall safe "FaxSetPortA"
  c_FaxSetPortA :: Ptr () -> Ptr () -> IO CInt
-- FaxPortHandle : HANDLE -> Ptr ()
-- PortInfo : FAX_PORT_INFOA* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

(cffi:defcfun ("FaxSetPortA" fax-set-port-a :convention :stdcall) :int32
  (fax-port-handle :pointer)   ; HANDLE
  (port-info :pointer))   ; FAX_PORT_INFOA*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FaxSetPortA = Win32::API::More->new('WINFAX',
    'BOOL FaxSetPortA(HANDLE FaxPortHandle, LPVOID PortInfo)');
# my $ret = $FaxSetPortA->Call($FaxPortHandle, $PortInfo);
# FaxPortHandle : HANDLE -> HANDLE
# PortInfo : FAX_PORT_INFOA* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
使用する型