Win32 API 日本語リファレンス
ホームGraphics.Printing.PrintTicket › PTGetPrintCapabilities

PTGetPrintCapabilities

関数
プリンターの印刷機能情報を取得する。
DLLprntvpt.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

HRESULT PTGetPrintCapabilities(
    HPTPROVIDER hProvider,
    IStream* pPrintTicket,   // optional
    IStream* pCapabilities,
    LPWSTR* pbstrErrorMessage   // optional
);

パラメーター

名前方向説明
hProviderHPTPROVIDERinPTOpenProviderで取得したプロバイダのハンドル。
pPrintTicketIStream*inoptional基準とする印刷チケットを保持するIStream。NULL可。
pCapabilitiesIStream*in取得したPrintCapabilities(XML)を受け取るIStream。
pbstrErrorMessageLPWSTR*outoptionalエラー時の説明文字列(BSTR)を受け取るポインタ。NULL可。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT PTGetPrintCapabilities(
    HPTPROVIDER hProvider,
    IStream* pPrintTicket,   // optional
    IStream* pCapabilities,
    LPWSTR* pbstrErrorMessage   // optional
);
[DllImport("prntvpt.dll", ExactSpelling = true)]
static extern int PTGetPrintCapabilities(
    IntPtr hProvider,   // HPTPROVIDER
    IntPtr pPrintTicket,   // IStream* optional
    IntPtr pCapabilities,   // IStream*
    IntPtr pbstrErrorMessage   // LPWSTR* optional, out
);
<DllImport("prntvpt.dll", ExactSpelling:=True)>
Public Shared Function PTGetPrintCapabilities(
    hProvider As IntPtr,   ' HPTPROVIDER
    pPrintTicket As IntPtr,   ' IStream* optional
    pCapabilities As IntPtr,   ' IStream*
    pbstrErrorMessage As IntPtr   ' LPWSTR* optional, out
) As Integer
End Function
' hProvider : HPTPROVIDER
' pPrintTicket : IStream* optional
' pCapabilities : IStream*
' pbstrErrorMessage : LPWSTR* optional, out
Declare PtrSafe Function PTGetPrintCapabilities Lib "prntvpt" ( _
    ByVal hProvider As LongPtr, _
    ByVal pPrintTicket As LongPtr, _
    ByVal pCapabilities As LongPtr, _
    ByVal pbstrErrorMessage As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

PTGetPrintCapabilities = ctypes.windll.prntvpt.PTGetPrintCapabilities
PTGetPrintCapabilities.restype = ctypes.c_int
PTGetPrintCapabilities.argtypes = [
    wintypes.HANDLE,  # hProvider : HPTPROVIDER
    ctypes.c_void_p,  # pPrintTicket : IStream* optional
    ctypes.c_void_p,  # pCapabilities : IStream*
    ctypes.c_void_p,  # pbstrErrorMessage : LPWSTR* optional, out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('prntvpt.dll')
PTGetPrintCapabilities = Fiddle::Function.new(
  lib['PTGetPrintCapabilities'],
  [
    Fiddle::TYPE_VOIDP,  # hProvider : HPTPROVIDER
    Fiddle::TYPE_VOIDP,  # pPrintTicket : IStream* optional
    Fiddle::TYPE_VOIDP,  # pCapabilities : IStream*
    Fiddle::TYPE_VOIDP,  # pbstrErrorMessage : LPWSTR* optional, out
  ],
  Fiddle::TYPE_INT)
#[link(name = "prntvpt")]
extern "system" {
    fn PTGetPrintCapabilities(
        hProvider: *mut core::ffi::c_void,  // HPTPROVIDER
        pPrintTicket: *mut core::ffi::c_void,  // IStream* optional
        pCapabilities: *mut core::ffi::c_void,  // IStream*
        pbstrErrorMessage: *mut *mut u16  // LPWSTR* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("prntvpt.dll")]
public static extern int PTGetPrintCapabilities(IntPtr hProvider, IntPtr pPrintTicket, IntPtr pCapabilities, IntPtr pbstrErrorMessage);
"@
$api = Add-Type -MemberDefinition $sig -Name 'prntvpt_PTGetPrintCapabilities' -Namespace Win32 -PassThru
# $api::PTGetPrintCapabilities(hProvider, pPrintTicket, pCapabilities, pbstrErrorMessage)
#uselib "prntvpt.dll"
#func global PTGetPrintCapabilities "PTGetPrintCapabilities" sptr, sptr, sptr, sptr
; PTGetPrintCapabilities hProvider, pPrintTicket, pCapabilities, varptr(pbstrErrorMessage)   ; 戻り値は stat
; hProvider : HPTPROVIDER -> "sptr"
; pPrintTicket : IStream* optional -> "sptr"
; pCapabilities : IStream* -> "sptr"
; pbstrErrorMessage : LPWSTR* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "prntvpt.dll"
#cfunc global PTGetPrintCapabilities "PTGetPrintCapabilities" sptr, sptr, sptr, var
; res = PTGetPrintCapabilities(hProvider, pPrintTicket, pCapabilities, pbstrErrorMessage)
; hProvider : HPTPROVIDER -> "sptr"
; pPrintTicket : IStream* optional -> "sptr"
; pCapabilities : IStream* -> "sptr"
; pbstrErrorMessage : LPWSTR* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT PTGetPrintCapabilities(HPTPROVIDER hProvider, IStream* pPrintTicket, IStream* pCapabilities, LPWSTR* pbstrErrorMessage)
#uselib "prntvpt.dll"
#cfunc global PTGetPrintCapabilities "PTGetPrintCapabilities" intptr, intptr, intptr, var
; res = PTGetPrintCapabilities(hProvider, pPrintTicket, pCapabilities, pbstrErrorMessage)
; hProvider : HPTPROVIDER -> "intptr"
; pPrintTicket : IStream* optional -> "intptr"
; pCapabilities : IStream* -> "intptr"
; pbstrErrorMessage : LPWSTR* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	prntvpt = windows.NewLazySystemDLL("prntvpt.dll")
	procPTGetPrintCapabilities = prntvpt.NewProc("PTGetPrintCapabilities")
)

// hProvider (HPTPROVIDER), pPrintTicket (IStream* optional), pCapabilities (IStream*), pbstrErrorMessage (LPWSTR* optional, out)
r1, _, err := procPTGetPrintCapabilities.Call(
	uintptr(hProvider),
	uintptr(pPrintTicket),
	uintptr(pCapabilities),
	uintptr(pbstrErrorMessage),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function PTGetPrintCapabilities(
  hProvider: THandle;   // HPTPROVIDER
  pPrintTicket: Pointer;   // IStream* optional
  pCapabilities: Pointer;   // IStream*
  pbstrErrorMessage: PPWideChar   // LPWSTR* optional, out
): Integer; stdcall;
  external 'prntvpt.dll' name 'PTGetPrintCapabilities';
result := DllCall("prntvpt\PTGetPrintCapabilities"
    , "Ptr", hProvider   ; HPTPROVIDER
    , "Ptr", pPrintTicket   ; IStream* optional
    , "Ptr", pCapabilities   ; IStream*
    , "Ptr", pbstrErrorMessage   ; LPWSTR* optional, out
    , "Int")   ; return: HRESULT
●PTGetPrintCapabilities(hProvider, pPrintTicket, pCapabilities, pbstrErrorMessage) = DLL("prntvpt.dll", "int PTGetPrintCapabilities(void*, void*, void*, void*)")
# 呼び出し: PTGetPrintCapabilities(hProvider, pPrintTicket, pCapabilities, pbstrErrorMessage)
# hProvider : HPTPROVIDER -> "void*"
# pPrintTicket : IStream* optional -> "void*"
# pCapabilities : IStream* -> "void*"
# pbstrErrorMessage : LPWSTR* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef PTGetPrintCapabilitiesNative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Void>, Pointer<Pointer<Utf16>>);
typedef PTGetPrintCapabilitiesDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Void>, Pointer<Pointer<Utf16>>);
final PTGetPrintCapabilities = DynamicLibrary.open('prntvpt.dll')
    .lookupFunction<PTGetPrintCapabilitiesNative, PTGetPrintCapabilitiesDart>('PTGetPrintCapabilities');
// hProvider : HPTPROVIDER -> Pointer<Void>
// pPrintTicket : IStream* optional -> Pointer<Void>
// pCapabilities : IStream* -> Pointer<Void>
// pbstrErrorMessage : LPWSTR* optional, out -> Pointer<Pointer<Utf16>>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function PTGetPrintCapabilities(
  hProvider: THandle;   // HPTPROVIDER
  pPrintTicket: Pointer;   // IStream* optional
  pCapabilities: Pointer;   // IStream*
  pbstrErrorMessage: PPWideChar   // LPWSTR* optional, out
): Integer; stdcall;
  external 'prntvpt.dll' name 'PTGetPrintCapabilities';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "PTGetPrintCapabilities"
  c_PTGetPrintCapabilities :: Ptr () -> Ptr () -> Ptr () -> Ptr CWString -> IO Int32
-- hProvider : HPTPROVIDER -> Ptr ()
-- pPrintTicket : IStream* optional -> Ptr ()
-- pCapabilities : IStream* -> Ptr ()
-- pbstrErrorMessage : LPWSTR* optional, out -> Ptr CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let ptgetprintcapabilities =
  foreign "PTGetPrintCapabilities"
    ((ptr void) @-> (ptr void) @-> (ptr void) @-> (ptr (ptr uint16_t)) @-> returning int32_t)
(* hProvider : HPTPROVIDER -> (ptr void) *)
(* pPrintTicket : IStream* optional -> (ptr void) *)
(* pCapabilities : IStream* -> (ptr void) *)
(* pbstrErrorMessage : LPWSTR* optional, out -> (ptr (ptr uint16_t)) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library prntvpt (t "prntvpt.dll"))
(cffi:use-foreign-library prntvpt)

(cffi:defcfun ("PTGetPrintCapabilities" ptget-print-capabilities :convention :stdcall) :int32
  (h-provider :pointer)   ; HPTPROVIDER
  (p-print-ticket :pointer)   ; IStream* optional
  (p-capabilities :pointer)   ; IStream*
  (pbstr-error-message :pointer))   ; LPWSTR* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $PTGetPrintCapabilities = Win32::API::More->new('prntvpt',
    'int PTGetPrintCapabilities(HANDLE hProvider, LPVOID pPrintTicket, LPVOID pCapabilities, LPVOID pbstrErrorMessage)');
# my $ret = $PTGetPrintCapabilities->Call($hProvider, $pPrintTicket, $pCapabilities, $pbstrErrorMessage);
# hProvider : HPTPROVIDER -> HANDLE
# pPrintTicket : IStream* optional -> LPVOID
# pCapabilities : IStream* -> LPVOID
# pbstrErrorMessage : LPWSTR* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型