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

GetPrinterDataA

関数
プリンタの構成データ値を取得する(ANSI版)。
DLLwinspool.drv文字セットANSI (-A)呼出規約winapi
📘 Microsoft Learn (日本語) · English

シグネチャ

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

DWORD GetPrinterDataA(
    PRINTER_HANDLE hPrinter,
    LPCSTR pValueName,
    DWORD* pType,   // optional
    BYTE* pData,   // optional
    DWORD nSize,
    DWORD* pcbNeeded
);

パラメーター

名前型方向説明
hPrinterPRINTER_HANDLEin設定値を取得する対象プリンターのハンドル。
pValueNameLPCSTRin取得する設定値の名前を指すポインタ。
pTypeDWORD*outoptional値のデータ型(REG_SZ等)を受け取る変数へのポインタ。NULL可。
pDataBYTE*outoptional取得した値データを受け取るバッファへのポインタ。
nSizeDWORDinpDataバッファのサイズ(バイト単位)。
pcbNeededDWORD*out必要なバイト数を受け取る変数へのポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD GetPrinterDataA(
    PRINTER_HANDLE hPrinter,
    LPCSTR pValueName,
    DWORD* pType,   // optional
    BYTE* pData,   // optional
    DWORD nSize,
    DWORD* pcbNeeded
);
[DllImport("winspool.drv", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint GetPrinterDataA(
    PRINTER_HANDLE hPrinter,   // PRINTER_HANDLE
    [MarshalAs(UnmanagedType.LPStr)] string pValueName,   // LPCSTR
    IntPtr pType,   // DWORD* optional, out
    IntPtr pData,   // BYTE* optional, out
    uint nSize,   // DWORD
    out uint pcbNeeded   // DWORD* out
);
<DllImport("winspool.drv", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function GetPrinterDataA(
    hPrinter As PRINTER_HANDLE,   ' PRINTER_HANDLE
    <MarshalAs(UnmanagedType.LPStr)> pValueName As String,   ' LPCSTR
    pType As IntPtr,   ' DWORD* optional, out
    pData As IntPtr,   ' BYTE* optional, out
    nSize As UInteger,   ' DWORD
    <Out> ByRef pcbNeeded As UInteger   ' DWORD* out
) As UInteger
End Function
' hPrinter : PRINTER_HANDLE
' pValueName : LPCSTR
' pType : DWORD* optional, out
' pData : BYTE* optional, out
' nSize : DWORD
' pcbNeeded : DWORD* out
Declare PtrSafe Function GetPrinterDataA Lib "winspool.drv" ( _
    ByVal hPrinter As LongPtr, _
    ByVal pValueName As String, _
    ByVal pType As LongPtr, _
    ByVal pData As LongPtr, _
    ByVal nSize As Long, _
    ByRef pcbNeeded As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetPrinterDataA = ctypes.windll.LoadLibrary("winspool.drv").GetPrinterDataA
GetPrinterDataA.restype = wintypes.DWORD
GetPrinterDataA.argtypes = [
    PRINTER_HANDLE,  # hPrinter : PRINTER_HANDLE
    wintypes.LPCSTR,  # pValueName : LPCSTR
    ctypes.POINTER(wintypes.DWORD),  # pType : DWORD* optional, out
    ctypes.POINTER(ctypes.c_ubyte),  # pData : BYTE* optional, out
    wintypes.DWORD,  # nSize : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pcbNeeded : DWORD* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('winspool.drv')
GetPrinterDataA = Fiddle::Function.new(
  lib['GetPrinterDataA'],
  [
    Fiddle::TYPE_VOIDP,  # hPrinter : PRINTER_HANDLE
    Fiddle::TYPE_VOIDP,  # pValueName : LPCSTR
    Fiddle::TYPE_VOIDP,  # pType : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # pData : BYTE* optional, out
    -Fiddle::TYPE_INT,  # nSize : DWORD
    Fiddle::TYPE_VOIDP,  # pcbNeeded : DWORD* out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "winspool.drv")]
extern "system" {
    fn GetPrinterDataA(
        hPrinter: PRINTER_HANDLE,  // PRINTER_HANDLE
        pValueName: *const u8,  // LPCSTR
        pType: *mut u32,  // DWORD* optional, out
        pData: *mut u8,  // BYTE* optional, out
        nSize: u32,  // DWORD
        pcbNeeded: *mut u32  // DWORD* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("winspool.drv", CharSet = CharSet.Ansi)]
public static extern uint GetPrinterDataA(PRINTER_HANDLE hPrinter, [MarshalAs(UnmanagedType.LPStr)] string pValueName, IntPtr pType, IntPtr pData, uint nSize, out uint pcbNeeded);
"@
$api = Add-Type -MemberDefinition $sig -Name 'winspool.drv_GetPrinterDataA' -Namespace Win32 -PassThru
# $api::GetPrinterDataA(hPrinter, pValueName, pType, pData, nSize, pcbNeeded)
#uselib "winspool.drv"
#func global GetPrinterDataA "GetPrinterDataA" sptr, sptr, sptr, sptr, sptr, sptr
; GetPrinterDataA hPrinter, pValueName, varptr(pType), varptr(pData), nSize, varptr(pcbNeeded)   ; 戻り値は stat
; hPrinter : PRINTER_HANDLE -> "sptr"
; pValueName : LPCSTR -> "sptr"
; pType : DWORD* optional, out -> "sptr"
; pData : BYTE* optional, out -> "sptr"
; nSize : DWORD -> "sptr"
; pcbNeeded : DWORD* out -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "winspool.drv"
#cfunc global GetPrinterDataA "GetPrinterDataA" int, str, var, var, int, var
; res = GetPrinterDataA(hPrinter, pValueName, pType, pData, nSize, pcbNeeded)
; hPrinter : PRINTER_HANDLE -> "int"
; pValueName : LPCSTR -> "str"
; pType : DWORD* optional, out -> "var"
; pData : BYTE* optional, out -> "var"
; nSize : DWORD -> "int"
; pcbNeeded : DWORD* out -> "var"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; DWORD GetPrinterDataA(PRINTER_HANDLE hPrinter, LPCSTR pValueName, DWORD* pType, BYTE* pData, DWORD nSize, DWORD* pcbNeeded)
#uselib "winspool.drv"
#cfunc global GetPrinterDataA "GetPrinterDataA" int, str, var, var, int, var
; res = GetPrinterDataA(hPrinter, pValueName, pType, pData, nSize, pcbNeeded)
; hPrinter : PRINTER_HANDLE -> "int"
; pValueName : LPCSTR -> "str"
; pType : DWORD* optional, out -> "var"
; pData : BYTE* optional, out -> "var"
; nSize : DWORD -> "int"
; pcbNeeded : DWORD* out -> "var"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winspool_drv = windows.NewLazySystemDLL("winspool.drv")
	procGetPrinterDataA = winspool_drv.NewProc("GetPrinterDataA")
)

// hPrinter (PRINTER_HANDLE), pValueName (LPCSTR), pType (DWORD* optional, out), pData (BYTE* optional, out), nSize (DWORD), pcbNeeded (DWORD* out)
r1, _, err := procGetPrinterDataA.Call(
	uintptr(hPrinter),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(pValueName))),
	uintptr(pType),
	uintptr(pData),
	uintptr(nSize),
	uintptr(pcbNeeded),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function GetPrinterDataA(
  hPrinter: PRINTER_HANDLE;   // PRINTER_HANDLE
  pValueName: PAnsiChar;   // LPCSTR
  pType: Pointer;   // DWORD* optional, out
  pData: Pointer;   // BYTE* optional, out
  nSize: DWORD;   // DWORD
  pcbNeeded: Pointer   // DWORD* out
): DWORD; stdcall;
  external 'winspool.drv' name 'GetPrinterDataA';
result := DllCall("winspool.drv\GetPrinterDataA"
    , "Ptr", hPrinter   ; PRINTER_HANDLE
    , "AStr", pValueName   ; LPCSTR
    , "Ptr", pType   ; DWORD* optional, out
    , "Ptr", pData   ; BYTE* optional, out
    , "UInt", nSize   ; DWORD
    , "Ptr", pcbNeeded   ; DWORD* out
    , "UInt")   ; return: DWORD
●GetPrinterDataA(hPrinter, pValueName, pType, pData, nSize, pcbNeeded) = DLL("winspool.drv", "dword GetPrinterDataA(void*, char*, void*, void*, dword, void*)")
# 呼び出し: GetPrinterDataA(hPrinter, pValueName, pType, pData, nSize, pcbNeeded)
# hPrinter : PRINTER_HANDLE -> "void*"
# pValueName : LPCSTR -> "char*"
# pType : DWORD* optional, out -> "void*"
# pData : BYTE* optional, out -> "void*"
# nSize : DWORD -> "dword"
# pcbNeeded : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef GetPrinterDataANative = Uint32 Function(PRINTER_HANDLE, Pointer<Utf8>, Pointer<Uint32>, Pointer<Uint8>, Uint32, Pointer<Uint32>);
typedef GetPrinterDataADart = int Function(int, Pointer<Utf8>, Pointer<Uint32>, Pointer<Uint8>, int, Pointer<Uint32>);
final GetPrinterDataA = DynamicLibrary.open('winspool.drv')
    .lookupFunction<GetPrinterDataANative, GetPrinterDataADart>('GetPrinterDataA');
// hPrinter : PRINTER_HANDLE -> PRINTER_HANDLE
// pValueName : LPCSTR -> Pointer<Utf8>
// pType : DWORD* optional, out -> Pointer<Uint32>
// pData : BYTE* optional, out -> Pointer<Uint8>
// nSize : DWORD -> Uint32
// pcbNeeded : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetPrinterDataA(
  hPrinter: PRINTER_HANDLE;   // PRINTER_HANDLE
  pValueName: PAnsiChar;   // LPCSTR
  pType: Pointer;   // DWORD* optional, out
  pData: Pointer;   // BYTE* optional, out
  nSize: DWORD;   // DWORD
  pcbNeeded: Pointer   // DWORD* out
): DWORD; stdcall;
  external 'winspool.drv' name 'GetPrinterDataA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetPrinterDataA"
  c_GetPrinterDataA :: PRINTER_HANDLE -> CString -> Ptr Word32 -> Ptr Word8 -> Word32 -> Ptr Word32 -> IO Word32
-- hPrinter : PRINTER_HANDLE -> PRINTER_HANDLE
-- pValueName : LPCSTR -> CString
-- pType : DWORD* optional, out -> Ptr Word32
-- pData : BYTE* optional, out -> Ptr Word8
-- nSize : DWORD -> Word32
-- pcbNeeded : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
-- ※値渡し構造体は GHC FFI で直接渡せません。Ptr で渡すラッパ(C側)経由にしてください。
open Ctypes
open Foreign

let getprinterdataa =
  foreign "GetPrinterDataA"
    (PRINTER_HANDLE @-> string @-> (ptr uint32_t) @-> (ptr uint8_t) @-> uint32_t @-> (ptr uint32_t) @-> returning uint32_t)
(* hPrinter : PRINTER_HANDLE -> PRINTER_HANDLE *)
(* pValueName : LPCSTR -> string *)
(* pType : DWORD* optional, out -> (ptr uint32_t) *)
(* pData : BYTE* optional, out -> (ptr uint8_t) *)
(* nSize : DWORD -> uint32_t *)
(* pcbNeeded : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winspool.drv (t "winspool.drv"))
(cffi:use-foreign-library winspool.drv)

(cffi:defcfun ("GetPrinterDataA" get-printer-data-a :convention :stdcall) :uint32
  (h-printer (:struct printer-handle))   ; PRINTER_HANDLE
  (p-value-name :string)   ; LPCSTR
  (p-type :pointer)   ; DWORD* optional, out
  (p-data :pointer)   ; BYTE* optional, out
  (n-size :uint32)   ; DWORD
  (pcb-needed :pointer))   ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetPrinterDataA = Win32::API::More->new('winspool.drv',
    'DWORD GetPrinterDataA(LPVOID hPrinter, LPCSTR pValueName, LPVOID pType, LPVOID pData, DWORD nSize, LPVOID pcbNeeded)');
# my $ret = $GetPrinterDataA->Call($hPrinter, $pValueName, $pType, $pData, $nSize, $pcbNeeded);
# hPrinter : PRINTER_HANDLE -> LPVOID
# pValueName : LPCSTR -> LPCSTR
# pType : DWORD* optional, out -> LPVOID
# pData : BYTE* optional, out -> LPVOID
# nSize : DWORD -> DWORD
# pcbNeeded : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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