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

FaxRegisterServiceProviderW

関数
ファクスサービスプロバイダー(FSP)を登録する。
DLLWINFAX.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL FaxRegisterServiceProviderW(
    LPCWSTR DeviceProvider,
    LPCWSTR FriendlyName,
    LPCWSTR ImageName,
    LPCWSTR TspName
);

パラメーター

名前方向説明
DeviceProviderLPCWSTRin登録するFAXサービスプロバイダの一意な識別子文字列を指定する。
FriendlyNameLPCWSTRin管理画面等に表示するプロバイダの表示名を指定する。
ImageNameLPCWSTRinプロバイダを実装するDLL等の実行イメージのパスを指定する。
TspNameLPCWSTRin関連付けるテレフォニーサービスプロバイダ(TSP)名を指定する。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL FaxRegisterServiceProviderW(
    LPCWSTR DeviceProvider,
    LPCWSTR FriendlyName,
    LPCWSTR ImageName,
    LPCWSTR TspName
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINFAX.dll", SetLastError = true, ExactSpelling = true)]
static extern bool FaxRegisterServiceProviderW(
    [MarshalAs(UnmanagedType.LPWStr)] string DeviceProvider,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string FriendlyName,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string ImageName,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string TspName   // LPCWSTR
);
<DllImport("WINFAX.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function FaxRegisterServiceProviderW(
    <MarshalAs(UnmanagedType.LPWStr)> DeviceProvider As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> FriendlyName As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> ImageName As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> TspName As String   ' LPCWSTR
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' DeviceProvider : LPCWSTR
' FriendlyName : LPCWSTR
' ImageName : LPCWSTR
' TspName : LPCWSTR
Declare PtrSafe Function FaxRegisterServiceProviderW Lib "winfax" ( _
    ByVal DeviceProvider As LongPtr, _
    ByVal FriendlyName As LongPtr, _
    ByVal ImageName As LongPtr, _
    ByVal TspName As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

FaxRegisterServiceProviderW = ctypes.windll.winfax.FaxRegisterServiceProviderW
FaxRegisterServiceProviderW.restype = wintypes.BOOL
FaxRegisterServiceProviderW.argtypes = [
    wintypes.LPCWSTR,  # DeviceProvider : LPCWSTR
    wintypes.LPCWSTR,  # FriendlyName : LPCWSTR
    wintypes.LPCWSTR,  # ImageName : LPCWSTR
    wintypes.LPCWSTR,  # TspName : LPCWSTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINFAX.dll')
FaxRegisterServiceProviderW = Fiddle::Function.new(
  lib['FaxRegisterServiceProviderW'],
  [
    Fiddle::TYPE_VOIDP,  # DeviceProvider : LPCWSTR
    Fiddle::TYPE_VOIDP,  # FriendlyName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # ImageName : LPCWSTR
    Fiddle::TYPE_VOIDP,  # TspName : LPCWSTR
  ],
  Fiddle::TYPE_INT)
#[link(name = "winfax")]
extern "system" {
    fn FaxRegisterServiceProviderW(
        DeviceProvider: *const u16,  // LPCWSTR
        FriendlyName: *const u16,  // LPCWSTR
        ImageName: *const u16,  // LPCWSTR
        TspName: *const u16  // LPCWSTR
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WINFAX.dll", SetLastError = true)]
public static extern bool FaxRegisterServiceProviderW([MarshalAs(UnmanagedType.LPWStr)] string DeviceProvider, [MarshalAs(UnmanagedType.LPWStr)] string FriendlyName, [MarshalAs(UnmanagedType.LPWStr)] string ImageName, [MarshalAs(UnmanagedType.LPWStr)] string TspName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINFAX_FaxRegisterServiceProviderW' -Namespace Win32 -PassThru
# $api::FaxRegisterServiceProviderW(DeviceProvider, FriendlyName, ImageName, TspName)
#uselib "WINFAX.dll"
#func global FaxRegisterServiceProviderW "FaxRegisterServiceProviderW" sptr, sptr, sptr, sptr
; FaxRegisterServiceProviderW DeviceProvider, FriendlyName, ImageName, TspName   ; 戻り値は stat
; DeviceProvider : LPCWSTR -> "sptr"
; FriendlyName : LPCWSTR -> "sptr"
; ImageName : LPCWSTR -> "sptr"
; TspName : LPCWSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WINFAX.dll"
#cfunc global FaxRegisterServiceProviderW "FaxRegisterServiceProviderW" wstr, wstr, wstr, wstr
; res = FaxRegisterServiceProviderW(DeviceProvider, FriendlyName, ImageName, TspName)
; DeviceProvider : LPCWSTR -> "wstr"
; FriendlyName : LPCWSTR -> "wstr"
; ImageName : LPCWSTR -> "wstr"
; TspName : LPCWSTR -> "wstr"
; BOOL FaxRegisterServiceProviderW(LPCWSTR DeviceProvider, LPCWSTR FriendlyName, LPCWSTR ImageName, LPCWSTR TspName)
#uselib "WINFAX.dll"
#cfunc global FaxRegisterServiceProviderW "FaxRegisterServiceProviderW" wstr, wstr, wstr, wstr
; res = FaxRegisterServiceProviderW(DeviceProvider, FriendlyName, ImageName, TspName)
; DeviceProvider : LPCWSTR -> "wstr"
; FriendlyName : LPCWSTR -> "wstr"
; ImageName : LPCWSTR -> "wstr"
; TspName : LPCWSTR -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winfax = windows.NewLazySystemDLL("WINFAX.dll")
	procFaxRegisterServiceProviderW = winfax.NewProc("FaxRegisterServiceProviderW")
)

// DeviceProvider (LPCWSTR), FriendlyName (LPCWSTR), ImageName (LPCWSTR), TspName (LPCWSTR)
r1, _, err := procFaxRegisterServiceProviderW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(DeviceProvider))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(FriendlyName))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(ImageName))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(TspName))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function FaxRegisterServiceProviderW(
  DeviceProvider: PWideChar;   // LPCWSTR
  FriendlyName: PWideChar;   // LPCWSTR
  ImageName: PWideChar;   // LPCWSTR
  TspName: PWideChar   // LPCWSTR
): BOOL; stdcall;
  external 'WINFAX.dll' name 'FaxRegisterServiceProviderW';
result := DllCall("WINFAX\FaxRegisterServiceProviderW"
    , "WStr", DeviceProvider   ; LPCWSTR
    , "WStr", FriendlyName   ; LPCWSTR
    , "WStr", ImageName   ; LPCWSTR
    , "WStr", TspName   ; LPCWSTR
    , "Int")   ; return: BOOL
●FaxRegisterServiceProviderW(DeviceProvider, FriendlyName, ImageName, TspName) = DLL("WINFAX.dll", "bool FaxRegisterServiceProviderW(char*, char*, char*, char*)")
# 呼び出し: FaxRegisterServiceProviderW(DeviceProvider, FriendlyName, ImageName, TspName)
# DeviceProvider : LPCWSTR -> "char*"
# FriendlyName : LPCWSTR -> "char*"
# ImageName : LPCWSTR -> "char*"
# TspName : LPCWSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef FaxRegisterServiceProviderWNative = Int32 Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Utf16>, Pointer<Utf16>);
typedef FaxRegisterServiceProviderWDart = int Function(Pointer<Utf16>, Pointer<Utf16>, Pointer<Utf16>, Pointer<Utf16>);
final FaxRegisterServiceProviderW = DynamicLibrary.open('WINFAX.dll')
    .lookupFunction<FaxRegisterServiceProviderWNative, FaxRegisterServiceProviderWDart>('FaxRegisterServiceProviderW');
// DeviceProvider : LPCWSTR -> Pointer<Utf16>
// FriendlyName : LPCWSTR -> Pointer<Utf16>
// ImageName : LPCWSTR -> Pointer<Utf16>
// TspName : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FaxRegisterServiceProviderW(
  DeviceProvider: PWideChar;   // LPCWSTR
  FriendlyName: PWideChar;   // LPCWSTR
  ImageName: PWideChar;   // LPCWSTR
  TspName: PWideChar   // LPCWSTR
): BOOL; stdcall;
  external 'WINFAX.dll' name 'FaxRegisterServiceProviderW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "FaxRegisterServiceProviderW"
  c_FaxRegisterServiceProviderW :: CWString -> CWString -> CWString -> CWString -> IO CInt
-- DeviceProvider : LPCWSTR -> CWString
-- FriendlyName : LPCWSTR -> CWString
-- ImageName : LPCWSTR -> CWString
-- TspName : LPCWSTR -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let faxregisterserviceproviderw =
  foreign "FaxRegisterServiceProviderW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> returning int32_t)
(* DeviceProvider : LPCWSTR -> (ptr uint16_t) *)
(* FriendlyName : LPCWSTR -> (ptr uint16_t) *)
(* ImageName : LPCWSTR -> (ptr uint16_t) *)
(* TspName : LPCWSTR -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winfax (t "WINFAX.dll"))
(cffi:use-foreign-library winfax)

(cffi:defcfun ("FaxRegisterServiceProviderW" fax-register-service-provider-w :convention :stdcall) :int32
  (device-provider (:string :encoding :utf-16le))   ; LPCWSTR
  (friendly-name (:string :encoding :utf-16le))   ; LPCWSTR
  (image-name (:string :encoding :utf-16le))   ; LPCWSTR
  (tsp-name (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FaxRegisterServiceProviderW = Win32::API::More->new('WINFAX',
    'BOOL FaxRegisterServiceProviderW(LPCWSTR DeviceProvider, LPCWSTR FriendlyName, LPCWSTR ImageName, LPCWSTR TspName)');
# my $ret = $FaxRegisterServiceProviderW->Call($DeviceProvider, $FriendlyName, $ImageName, $TspName);
# DeviceProvider : LPCWSTR -> LPCWSTR
# FriendlyName : LPCWSTR -> LPCWSTR
# ImageName : LPCWSTR -> LPCWSTR
# TspName : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。