Win32 API 日本語リファレンス
ホーム › Storage.Xps › DeviceCapabilitiesA

DeviceCapabilitiesA

関数
プリンタドライバの機能や対応値を問い合わせる(ANSI版)。
DLLwinspool.drv文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// winspool.drv  (ANSI / -A)
#include <windows.h>

INT DeviceCapabilitiesA(
    LPCSTR pDevice,
    LPCSTR pPort,   // optional
    PRINTER_DEVICE_CAPABILITIES fwCapability,
    LPSTR pOutput,   // optional
    const DEVMODEA* pDevMode   // optional
);

パラメーター

名前型方向説明
pDeviceLPCSTRinプリンターの名前を格納する null 終端文字列へのポインター。これはプリンタードライバーの名前ではなく、プリンターの名前である点に注意してください。
pPortLPCSTRinoptionalデバイスが接続されているポート (LPT1 など) の名前を格納する null 終端文字列へのポインター。
fwCapabilityPRINTER_DEVICE_CAPABILITIESin

照会する機能。このパラメーターには、次のいずれかの値を指定できます。

値 意味
DC_BINNAMES
プリンターの給紙トレイの名前を取得します。pOutput バッファーは文字列バッファーの配列を受け取ります。各文字列バッファーは 24 文字分の長さで、給紙トレイの名前を格納します。戻り値は配列内のエントリ数を示します。名前が 24 文字ちょうどでない限り、名前文字列は null 終端されます。pOutput が NULL の場合、戻り値は必要なトレイのエントリ数です。
DC_BINS
利用可能な給紙トレイの一覧を取得します。pOutput バッファーは、プリンターで利用可能な給紙元を示す WORD 値の配列を受け取ります。戻り値は配列内のエントリ数を示します。配列に格納され得る値の一覧については、DEVMODE 構造体の dmDefaultSource メンバーの説明を参照してください。pOutput が NULL の場合、戻り値は配列に必要なエントリ数を示します。
DC_COLLATE
プリンターが部単位印刷をサポートしている場合、戻り値は 1 です。それ以外の場合、戻り値は 0 です。pOutput パラメーターは使用されません。
DC_COLORDEVICE
プリンターがカラー印刷をサポートしている場合、戻り値は 1 です。それ以外の場合、戻り値は 0 です。pOutput パラメーターは使用されません。
DC_COPIES
デバイスが印刷できる部数を返します。
DC_DRIVER
プリンタードライバーのバージョン番号を返します。
DC_DUPLEX
プリンターが両面印刷をサポートしている場合、戻り値は 1 です。それ以外の場合、戻り値は 0 です。pOutput パラメーターは使用されません。
DC_ENUMRESOLUTIONS
プリンターがサポートする解像度の一覧を取得します。pOutput バッファーは LONG 値の配列を受け取ります。サポートされる解像度ごとに、その解像度の x 方向と y 方向の大きさを 1 インチあたりのドット数で指定する 2 つの LONG 値の組が配列に格納されます。戻り値はサポートされる解像度の数を示します。pOutput が NULL の場合、戻り値はサポートされる解像度の数を示します。
DC_EXTRA
プリンタードライバーの DEVMODE 構造体のうち、デバイス固有部分に必要なバイト数を返します。
DC_FIELDS
プリンタードライバーの DEVMODE 構造体の dmFields メンバーを返します。dmFields メンバーは、構造体のデバイス非依存部分のうち、どのメンバーがプリンタードライバーでサポートされているかを示します。
DC_FILEDEPENDENCIES
ドライバーのインストール時に読み込む必要がある追加ファイルの名前を取得します。pOutput バッファーは文字列バッファーの配列を受け取ります。各文字列バッファーは 64 文字分の長さで、ファイル名を格納します。戻り値は配列内のエントリ数を示します。名前が 64 文字ちょうどでない限り、名前文字列は null 終端されます。pOutput が NULL の場合、戻り値はファイル数です。
DC_MAXEXTENT
プリンタードライバーの DEVMODE 構造体の dmPaperLength メンバーおよび dmPaperWidth メンバーで指定できる最大の用紙サイズを返します。戻り値の LOWORD には dmPaperWidth の最大値が、HIWORD には dmPaperLength の最大値が格納されます。
DC_MEDIAREADY
現在使用可能な用紙フォームの名前を取得します。pOutput バッファーは文字列バッファーの配列を受け取ります。各文字列バッファーは 64 文字分の長さで、用紙フォームの名前を格納します。戻り値は配列内のエントリ数を示します。名前が 64 文字ちょうどでない限り、名前文字列は null 終端されます。pOutput が NULL の場合、戻り値は用紙フォームの数です。
DC_MEDIATYPENAMES
サポートされるメディアの種類の名前を取得します。pOutput バッファーは文字列バッファーの配列を受け取ります。各文字列バッファーは 64 文字分の長さで、サポートされるメディアの種類の名前を格納します。戻り値は配列内のエントリ数を示します。名前が 64 文字ちょうどでない限り、文字列は null 終端されます。pOutput が NULL の場合、戻り値は必要なメディアの種類の名前の数です。
DC_MEDIATYPES
サポートされるメディアの種類の一覧を取得します。pOutput バッファーは、サポートされるメディアの種類を示す DWORD 値の配列を受け取ります。戻り値は配列内のエントリ数を示します。配列に格納され得る値の一覧については、DEVMODE 構造体の dmMediaType メンバーの説明を参照してください。pOutput が NULL の場合、戻り値は配列に必要なエントリ数を示します。
DC_MINEXTENT
プリンタードライバーの DEVMODE 構造体の dmPaperLength メンバーおよび dmPaperWidth メンバーで指定できる最小の用紙サイズを返します。戻り値の LOWORD には dmPaperWidth の最小値が、HIWORD には dmPaperLength の最小値が格納されます。
DC_ORIENTATION
デバイスにおける縦向き (portrait) と横向き (landscape) の関係を、縦向きを反時計回りに何度回転させると横向きになるかという角度で返します。戻り値は次のいずれかです。
0
横向きはサポートされません。
90
縦向きを 90 度回転させると横向きになります。
270
縦向きを 270 度回転させると横向きになります。
DC_NUP
1 枚の印刷ページに複数のドキュメントページを印刷するプリンターの能力を示す整数の配列を取得します。pOutput バッファーは DWORD 値の配列を受け取ります。各値は、1 枚の印刷ページあたりにサポートされるドキュメントページ数を表します。戻り値は配列内のエントリ数を示します。pOutput が NULL の場合、戻り値は配列に必要なエントリ数を示します。
DC_PAPERNAMES
サポートされる用紙名 (Letter や Legal など) の一覧を取得します。pOutput バッファーは文字列バッファーの配列を受け取ります。各文字列バッファーは 64 文字分の長さで、用紙フォームの名前を格納します。戻り値は配列内のエントリ数を示します。名前が 64 文字ちょうどでない限り、名前文字列は null 終端されます。pOutput が NULL の場合、戻り値は用紙フォームの数です。
DC_PAPERS
サポートされる用紙サイズの一覧を取得します。pOutput バッファーは、プリンターで利用可能な用紙サイズを示す WORD 値の配列を受け取ります。戻り値は配列内のエントリ数を示します。配列に格納され得る値の一覧については、DEVMODE 構造体の dmPaperSize メンバーの説明を参照してください。pOutput が NULL の場合、戻り値は配列に必要なエントリ数を示します。
DC_PAPERSIZE
サポートされる各用紙サイズの寸法を、0.1 ミリメートル単位で取得します。pOutput バッファーは POINT 構造体の配列を受け取ります。各構造体には、用紙が DMORIENT_PORTRAIT の向きであると仮定した場合の用紙サイズの幅 (x 方向) と長さ (y 方向) が格納されます。戻り値は配列内のエントリ数を示します。
DC_PERSONALITY
プリンターがサポートするプリンター記述言語の一覧を取得します。pOutput バッファーは文字列バッファーの配列を受け取ります。各バッファーは 32 文字分の長さで、プリンター記述言語の名前を格納します。戻り値は配列内のエントリ数を示します。名前が 32 文字ちょうどでない限り、名前文字列は null 終端されます。pOutput が NULL の場合、戻り値は必要な配列エントリ数を示します。
DC_PRINTERMEM
戻り値は、利用可能なプリンターメモリの容量 (キロバイト単位) です。pOutput パラメーターは使用されません。
DC_PRINTRATE
戻り値はプリンターの印刷速度を示します。DC_PRINTRATEUNIT に対して返される値は、DC_PRINTRATE の値の単位を示します。pOutput パラメーターは使用されません。
DC_PRINTRATEPPM
戻り値はプリンターの印刷速度を、1 分あたりのページ数で示します。pOutput パラメーターは使用されません。
DC_PRINTRATEUNIT
戻り値は、DC_PRINTRATE フラグに対して返される値の印刷速度の単位を示す、次のいずれかの値です。pOutput パラメーターは使用されません。
PRINTRATEUNIT_CPS
1 秒あたりの文字数。
PRINTRATEUNIT_IPM
1 分あたりのインチ数。
PRINTRATEUNIT_LPM
1 分あたりの行数。
PRINTRATEUNIT_PPM
1 分あたりのページ数。
DC_SIZE
プリンタードライバーの DEVMODE 構造体の dmSize メンバーを返します。
DC_STAPLE
プリンターがステープル留めをサポートしている場合、戻り値は 0 以外の値です。それ以外の場合、戻り値は 0 です。pOutput パラメーターは使用されません。
DC_TRUETYPE
ドライバーが TrueType フォントを扱う能力を取得します。DC_TRUETYPE の場合、pOutput パラメーターは NULL にする必要があります。戻り値は次の値の 1 つ以上の組み合わせです。
DCTT_BITMAP
デバイスは TrueType フォントをグラフィックスとして印刷できます。
DCTT_DOWNLOAD
デバイスは TrueType フォントをダウンロードできます。
DCTT_SUBDEV
デバイスは TrueType フォントをデバイスフォントで置き換えることができます。
DC_VERSION
プリンタードライバーが準拠する仕様のバージョンを返します。
pOutputLPSTRoutoptional配列へのポインター。配列の形式は fwCapability パラメーターの設定によって異なります。pOutput が NULL の場合に何が返されるかについては、上記の各機能の説明を参照してください。
pDevModeDEVMODEA*inoptionalDEVMODE 構造体へのポインター。このパラメーターが NULL の場合、DeviceCapabilities は指定されたプリンタードライバーの現在の既定の初期化値を取得します。それ以外の場合、この関数は pDevMode が指す構造体に格納されている値を取得します。

戻り値の型: INT

公式ドキュメント

DeviceCapabilities 関数は、プリンタードライバーの機能を取得します。(ANSI)

戻り値

関数が成功した場合、戻り値は fwCapability パラメーターの設定によって異なります。戻り値が 0 の場合は、一般に、関数自体は正常に完了したものの、サポートされていない機能があるなど何らかの失敗があったことを示します。詳細については、fwCapability の各値の説明を参照してください。

関数が -1 を返した場合は、その機能がサポートされていないか、関数の一般的な失敗が発生したかのいずれかを意味します。

解説(Remarks)

メモ これはブロッキング関数 (同期関数) であり、すぐに戻らない場合があります。この関数が戻るまでの速さは、ネットワークの状態、プリントサーバーの構成、プリンタードライバーの実装といった、アプリケーションの作成時には予測が難しい実行時の要因に依存します。ユーザーインターフェイスとのやり取りを管理するスレッドからこの関数を呼び出すと、アプリケーションが応答していないように見えることがあります。
pDevMode パラメーターが指す DEVMODE 構造体は、DocumentProperties 関数を呼び出すことで取得できます。

プリンタードライバーがカスタムのデバイス機能をサポートする場合、ドライバーはカスタム機能ごとに SetPrinterData 関数を呼び出す必要があります。SetPrinterData 関数は適切なプリンターデータを印刷システムに追加し、これにより 32 ビットアプリケーションが 64 ビット版 Windows 上でカスタム機能にアクセスできるようになります。

カスタム機能ごとに、まずその機能の種類を記述するプリンターデータを追加する必要があります。そのためには、SetPrinterData を呼び出すときに pValueName 文字列を CustomDeviceCapabilityType_Xxx に設定します。ここで "Xxx" はその機能の 16 進表記です。たとえば "CustomDeviceCapabilityType_1234" のようになります。設定するレジストリデータは REG_DWORD 型である必要があり、その値には次のいずれかを設定します。

カスタム機能が項目の配列である場合は、配列内の 1 項目のサイズに関する情報を提供するために、SetPinterData をもう一度呼び出す必要があります。そのためには、SetPinterData を呼び出すときに指定する pValueName 文字列を "CustomDeviceCapabilitySize_Xxx" にする必要があります。ここで Xxx はその機能の 16 進表記です。たとえば "CustomDeviceCapabilitySize_1234" のようになります。設定するレジストリデータは REG_DWORD 型である必要があり、その値には配列内の 1 項目のサイズをバイト単位で設定します。
メモ

wingdi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして、DeviceCapabilities を定義しています。エンコーディング非依存のエイリアスと、エンコーディング非依存でないコードを混在させると、コンパイルエラーや実行時エラーの原因となる不一致が生じる可能性があります。詳細については、関数プロトタイプの規則を参照してください。

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

各言語での呼び出し定義

// winspool.drv  (ANSI / -A)
#include <windows.h>

INT DeviceCapabilitiesA(
    LPCSTR pDevice,
    LPCSTR pPort,   // optional
    PRINTER_DEVICE_CAPABILITIES fwCapability,
    LPSTR pOutput,   // optional
    const DEVMODEA* pDevMode   // optional
);
[DllImport("winspool.drv", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern int DeviceCapabilitiesA(
    [MarshalAs(UnmanagedType.LPStr)] string pDevice,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string pPort,   // LPCSTR optional
    ushort fwCapability,   // PRINTER_DEVICE_CAPABILITIES
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pOutput,   // LPSTR optional, out
    IntPtr pDevMode   // DEVMODEA* optional
);
<DllImport("winspool.drv", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function DeviceCapabilitiesA(
    <MarshalAs(UnmanagedType.LPStr)> pDevice As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> pPort As String,   ' LPCSTR optional
    fwCapability As UShort,   ' PRINTER_DEVICE_CAPABILITIES
    <MarshalAs(UnmanagedType.LPStr)> pOutput As System.Text.StringBuilder,   ' LPSTR optional, out
    pDevMode As IntPtr   ' DEVMODEA* optional
) As Integer
End Function
' pDevice : LPCSTR
' pPort : LPCSTR optional
' fwCapability : PRINTER_DEVICE_CAPABILITIES
' pOutput : LPSTR optional, out
' pDevMode : DEVMODEA* optional
Declare PtrSafe Function DeviceCapabilitiesA Lib "winspool.drv" ( _
    ByVal pDevice As String, _
    ByVal pPort As String, _
    ByVal fwCapability As Integer, _
    ByVal pOutput As String, _
    ByVal pDevMode As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DeviceCapabilitiesA = ctypes.windll.LoadLibrary("winspool.drv").DeviceCapabilitiesA
DeviceCapabilitiesA.restype = ctypes.c_int
DeviceCapabilitiesA.argtypes = [
    wintypes.LPCSTR,  # pDevice : LPCSTR
    wintypes.LPCSTR,  # pPort : LPCSTR optional
    ctypes.c_ushort,  # fwCapability : PRINTER_DEVICE_CAPABILITIES
    wintypes.LPSTR,  # pOutput : LPSTR optional, out
    ctypes.c_void_p,  # pDevMode : DEVMODEA* optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('winspool.drv')
DeviceCapabilitiesA = Fiddle::Function.new(
  lib['DeviceCapabilitiesA'],
  [
    Fiddle::TYPE_VOIDP,  # pDevice : LPCSTR
    Fiddle::TYPE_VOIDP,  # pPort : LPCSTR optional
    -Fiddle::TYPE_SHORT,  # fwCapability : PRINTER_DEVICE_CAPABILITIES
    Fiddle::TYPE_VOIDP,  # pOutput : LPSTR optional, out
    Fiddle::TYPE_VOIDP,  # pDevMode : DEVMODEA* optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "winspool.drv")]
extern "system" {
    fn DeviceCapabilitiesA(
        pDevice: *const u8,  // LPCSTR
        pPort: *const u8,  // LPCSTR optional
        fwCapability: u16,  // PRINTER_DEVICE_CAPABILITIES
        pOutput: *mut u8,  // LPSTR optional, out
        pDevMode: *const DEVMODEA  // DEVMODEA* optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("winspool.drv", CharSet = CharSet.Ansi)]
public static extern int DeviceCapabilitiesA([MarshalAs(UnmanagedType.LPStr)] string pDevice, [MarshalAs(UnmanagedType.LPStr)] string pPort, ushort fwCapability, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pOutput, IntPtr pDevMode);
"@
$api = Add-Type -MemberDefinition $sig -Name 'winspool.drv_DeviceCapabilitiesA' -Namespace Win32 -PassThru
# $api::DeviceCapabilitiesA(pDevice, pPort, fwCapability, pOutput, pDevMode)
#uselib "winspool.drv"
#func global DeviceCapabilitiesA "DeviceCapabilitiesA" sptr, sptr, sptr, sptr, sptr
; DeviceCapabilitiesA pDevice, pPort, fwCapability, varptr(pOutput), varptr(pDevMode)   ; 戻り値は stat
; pDevice : LPCSTR -> "sptr"
; pPort : LPCSTR optional -> "sptr"
; fwCapability : PRINTER_DEVICE_CAPABILITIES -> "sptr"
; pOutput : LPSTR optional, out -> "sptr"
; pDevMode : DEVMODEA* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "winspool.drv"
#cfunc global DeviceCapabilitiesA "DeviceCapabilitiesA" str, str, int, var, var
; res = DeviceCapabilitiesA(pDevice, pPort, fwCapability, pOutput, pDevMode)
; pDevice : LPCSTR -> "str"
; pPort : LPCSTR optional -> "str"
; fwCapability : PRINTER_DEVICE_CAPABILITIES -> "int"
; pOutput : LPSTR optional, out -> "var"
; pDevMode : DEVMODEA* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; INT DeviceCapabilitiesA(LPCSTR pDevice, LPCSTR pPort, PRINTER_DEVICE_CAPABILITIES fwCapability, LPSTR pOutput, DEVMODEA* pDevMode)
#uselib "winspool.drv"
#cfunc global DeviceCapabilitiesA "DeviceCapabilitiesA" str, str, int, var, var
; res = DeviceCapabilitiesA(pDevice, pPort, fwCapability, pOutput, pDevMode)
; pDevice : LPCSTR -> "str"
; pPort : LPCSTR optional -> "str"
; fwCapability : PRINTER_DEVICE_CAPABILITIES -> "int"
; pOutput : LPSTR optional, out -> "var"
; pDevMode : DEVMODEA* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winspool_drv = windows.NewLazySystemDLL("winspool.drv")
	procDeviceCapabilitiesA = winspool_drv.NewProc("DeviceCapabilitiesA")
)

// pDevice (LPCSTR), pPort (LPCSTR optional), fwCapability (PRINTER_DEVICE_CAPABILITIES), pOutput (LPSTR optional, out), pDevMode (DEVMODEA* optional)
r1, _, err := procDeviceCapabilitiesA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(pDevice))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(pPort))),
	uintptr(fwCapability),
	uintptr(pOutput),
	uintptr(pDevMode),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function DeviceCapabilitiesA(
  pDevice: PAnsiChar;   // LPCSTR
  pPort: PAnsiChar;   // LPCSTR optional
  fwCapability: Word;   // PRINTER_DEVICE_CAPABILITIES
  pOutput: PAnsiChar;   // LPSTR optional, out
  pDevMode: Pointer   // DEVMODEA* optional
): Integer; stdcall;
  external 'winspool.drv' name 'DeviceCapabilitiesA';
result := DllCall("winspool.drv\DeviceCapabilitiesA"
    , "AStr", pDevice   ; LPCSTR
    , "AStr", pPort   ; LPCSTR optional
    , "UShort", fwCapability   ; PRINTER_DEVICE_CAPABILITIES
    , "Ptr", pOutput   ; LPSTR optional, out
    , "Ptr", pDevMode   ; DEVMODEA* optional
    , "Int")   ; return: INT
●DeviceCapabilitiesA(pDevice, pPort, fwCapability, pOutput, pDevMode) = DLL("winspool.drv", "int DeviceCapabilitiesA(char*, char*, int, char*, void*)")
# 呼び出し: DeviceCapabilitiesA(pDevice, pPort, fwCapability, pOutput, pDevMode)
# pDevice : LPCSTR -> "char*"
# pPort : LPCSTR optional -> "char*"
# fwCapability : PRINTER_DEVICE_CAPABILITIES -> "int"
# pOutput : LPSTR optional, out -> "char*"
# pDevMode : DEVMODEA* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "winspool.drv" fn DeviceCapabilitiesA(
    pDevice: [*c]const u8, // LPCSTR
    pPort: [*c]const u8, // LPCSTR optional
    fwCapability: u16, // PRINTER_DEVICE_CAPABILITIES
    pOutput: [*c]u8, // LPSTR optional, out
    pDevMode: [*c]DEVMODEA // DEVMODEA* optional
) callconv(std.os.windows.WINAPI) i32;
proc DeviceCapabilitiesA(
    pDevice: cstring,  # LPCSTR
    pPort: cstring,  # LPCSTR optional
    fwCapability: uint16,  # PRINTER_DEVICE_CAPABILITIES
    pOutput: ptr char,  # LPSTR optional, out
    pDevMode: ptr DEVMODEA  # DEVMODEA* optional
): int32 {.importc: "DeviceCapabilitiesA", stdcall, dynlib: "winspool.drv".}
pragma(lib, "winspool.drv");
extern(Windows)
int DeviceCapabilitiesA(
    const(char)* pDevice,   // LPCSTR
    const(char)* pPort,   // LPCSTR optional
    ushort fwCapability,   // PRINTER_DEVICE_CAPABILITIES
    char* pOutput,   // LPSTR optional, out
    DEVMODEA* pDevMode   // DEVMODEA* optional
);
ccall((:DeviceCapabilitiesA, "winspool.drv"), stdcall, Int32,
      (Cstring, Cstring, UInt16, Ptr{UInt8}, Ptr{DEVMODEA}),
      pDevice, pPort, fwCapability, pOutput, pDevMode)
# pDevice : LPCSTR -> Cstring
# pPort : LPCSTR optional -> Cstring
# fwCapability : PRINTER_DEVICE_CAPABILITIES -> UInt16
# pOutput : LPSTR optional, out -> Ptr{UInt8}
# pDevMode : DEVMODEA* optional -> Ptr{DEVMODEA}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t DeviceCapabilitiesA(
    const char* pDevice,
    const char* pPort,
    uint16_t fwCapability,
    char* pOutput,
    void* pDevMode);
]]
local winspool.drv = ffi.load("winspool.drv")
-- winspool.drv.DeviceCapabilitiesA(pDevice, pPort, fwCapability, pOutput, pDevMode)
-- pDevice : LPCSTR
-- pPort : LPCSTR optional
-- fwCapability : PRINTER_DEVICE_CAPABILITIES
-- pOutput : LPSTR optional, out
-- pDevMode : DEVMODEA* optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('winspool.drv');
const DeviceCapabilitiesA = lib.func('__stdcall', 'DeviceCapabilitiesA', 'int32_t', ['str', 'str', 'uint16_t', 'char *', 'void *']);
// DeviceCapabilitiesA(pDevice, pPort, fwCapability, pOutput, pDevMode)
// pDevice : LPCSTR -> 'str'
// pPort : LPCSTR optional -> 'str'
// fwCapability : PRINTER_DEVICE_CAPABILITIES -> 'uint16_t'
// pOutput : LPSTR optional, out -> 'char *'
// pDevMode : DEVMODEA* optional -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("winspool.drv", {
  DeviceCapabilitiesA: { parameters: ["buffer", "buffer", "u16", "buffer", "pointer"], result: "i32" },
});
// lib.symbols.DeviceCapabilitiesA(pDevice, pPort, fwCapability, pOutput, pDevMode)
// pDevice : LPCSTR -> "buffer"
// pPort : LPCSTR optional -> "buffer"
// fwCapability : PRINTER_DEVICE_CAPABILITIES -> "u16"
// pOutput : LPSTR optional, out -> "buffer"
// pDevMode : DEVMODEA* optional -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t DeviceCapabilitiesA(
    const char* pDevice,
    const char* pPort,
    uint16_t fwCapability,
    char* pOutput,
    void* pDevMode);
C, "winspool.drv");
// $ffi->DeviceCapabilitiesA(pDevice, pPort, fwCapability, pOutput, pDevMode);
// pDevice : LPCSTR
// pPort : LPCSTR optional
// fwCapability : PRINTER_DEVICE_CAPABILITIES
// pOutput : LPSTR optional, out
// pDevMode : DEVMODEA* optional
// 構造体/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 Winspool.drv extends StdCallLibrary {
    Winspool.drv INSTANCE = Native.load("winspool.drv", Winspool.drv.class, W32APIOptions.ASCII_OPTIONS);
    int DeviceCapabilitiesA(
        String pDevice,   // LPCSTR
        String pPort,   // LPCSTR optional
        short fwCapability,   // PRINTER_DEVICE_CAPABILITIES
        byte[] pOutput,   // LPSTR optional, out
        Pointer pDevMode   // DEVMODEA* optional
    );
}
@[Link("winspool.drv")]
lib Libwinspool.drv
  fun DeviceCapabilitiesA = DeviceCapabilitiesA(
    pDevice : UInt8*,   # LPCSTR
    pPort : UInt8*,   # LPCSTR optional
    fwCapability : UInt16,   # PRINTER_DEVICE_CAPABILITIES
    pOutput : UInt8*,   # LPSTR optional, out
    pDevMode : DEVMODEA*   # DEVMODEA* optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef DeviceCapabilitiesANative = Int32 Function(Pointer<Utf8>, Pointer<Utf8>, Uint16, Pointer<Utf8>, Pointer<Void>);
typedef DeviceCapabilitiesADart = int Function(Pointer<Utf8>, Pointer<Utf8>, int, Pointer<Utf8>, Pointer<Void>);
final DeviceCapabilitiesA = DynamicLibrary.open('winspool.drv')
    .lookupFunction<DeviceCapabilitiesANative, DeviceCapabilitiesADart>('DeviceCapabilitiesA');
// pDevice : LPCSTR -> Pointer<Utf8>
// pPort : LPCSTR optional -> Pointer<Utf8>
// fwCapability : PRINTER_DEVICE_CAPABILITIES -> Uint16
// pOutput : LPSTR optional, out -> Pointer<Utf8>
// pDevMode : DEVMODEA* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DeviceCapabilitiesA(
  pDevice: PAnsiChar;   // LPCSTR
  pPort: PAnsiChar;   // LPCSTR optional
  fwCapability: Word;   // PRINTER_DEVICE_CAPABILITIES
  pOutput: PAnsiChar;   // LPSTR optional, out
  pDevMode: Pointer   // DEVMODEA* optional
): Integer; stdcall;
  external 'winspool.drv' name 'DeviceCapabilitiesA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DeviceCapabilitiesA"
  c_DeviceCapabilitiesA :: CString -> CString -> Word16 -> CString -> Ptr () -> IO Int32
-- pDevice : LPCSTR -> CString
-- pPort : LPCSTR optional -> CString
-- fwCapability : PRINTER_DEVICE_CAPABILITIES -> Word16
-- pOutput : LPSTR optional, out -> CString
-- pDevMode : DEVMODEA* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let devicecapabilitiesa =
  foreign "DeviceCapabilitiesA"
    (string @-> string @-> uint16_t @-> string @-> (ptr void) @-> returning int32_t)
(* pDevice : LPCSTR -> string *)
(* pPort : LPCSTR optional -> string *)
(* fwCapability : PRINTER_DEVICE_CAPABILITIES -> uint16_t *)
(* pOutput : LPSTR optional, out -> string *)
(* pDevMode : DEVMODEA* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winspool.drv (t "winspool.drv"))
(cffi:use-foreign-library winspool.drv)

(cffi:defcfun ("DeviceCapabilitiesA" device-capabilities-a :convention :stdcall) :int32
  (p-device :string)   ; LPCSTR
  (p-port :string)   ; LPCSTR optional
  (fw-capability :uint16)   ; PRINTER_DEVICE_CAPABILITIES
  (p-output :pointer)   ; LPSTR optional, out
  (p-dev-mode :pointer))   ; DEVMODEA* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DeviceCapabilitiesA = Win32::API::More->new('winspool.drv',
    'int DeviceCapabilitiesA(LPCSTR pDevice, LPCSTR pPort, WORD fwCapability, LPSTR pOutput, LPVOID pDevMode)');
# my $ret = $DeviceCapabilitiesA->Call($pDevice, $pPort, $fwCapability, $pOutput, $pDevMode);
# pDevice : LPCSTR -> LPCSTR
# pPort : LPCSTR optional -> LPCSTR
# fwCapability : PRINTER_DEVICE_CAPABILITIES -> WORD
# pOutput : LPSTR optional, out -> LPSTR
# pDevMode : DEVMODEA* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
公式の関連項目
使用する型