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

SetPrinterDataExA

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

シグネチャ

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

DWORD SetPrinterDataExA(
    PRINTER_HANDLE hPrinter,
    LPCSTR pKeyName,
    LPCSTR pValueName,
    DWORD Type,
    BYTE* pData,
    DWORD cbData
);

パラメーター

名前型方向説明
hPrinterPRINTER_HANDLEin設定値を書き込む対象プリンターのハンドル。
pKeyNameLPCSTRin値を格納するレジストリキーのパスを指すポインタ。
pValueNameLPCSTRin設定する値の名前を指すポインタ。
TypeDWORDin値のデータ型を示すREG_SZ等のレジストリ型定数。
pDataBYTE*in書き込む値データを格納したバッファへのポインタ。
cbDataDWORDin書き込むデータのサイズ(バイト単位)。

戻り値の型: DWORD

各言語での呼び出し定義

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

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

SetPrinterDataExA = ctypes.windll.LoadLibrary("winspool.drv").SetPrinterDataExA
SetPrinterDataExA.restype = wintypes.DWORD
SetPrinterDataExA.argtypes = [
    PRINTER_HANDLE,  # hPrinter : PRINTER_HANDLE
    wintypes.LPCSTR,  # pKeyName : LPCSTR
    wintypes.LPCSTR,  # pValueName : LPCSTR
    wintypes.DWORD,  # Type : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # pData : BYTE*
    wintypes.DWORD,  # cbData : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	winspool_drv = windows.NewLazySystemDLL("winspool.drv")
	procSetPrinterDataExA = winspool_drv.NewProc("SetPrinterDataExA")
)

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

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

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

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

let setprinterdataexa =
  foreign "SetPrinterDataExA"
    (PRINTER_HANDLE @-> string @-> string @-> uint32_t @-> (ptr uint8_t) @-> uint32_t @-> returning uint32_t)
(* hPrinter : PRINTER_HANDLE -> PRINTER_HANDLE *)
(* pKeyName : LPCSTR -> string *)
(* pValueName : LPCSTR -> string *)
(* Type : DWORD -> uint32_t *)
(* pData : BYTE* -> (ptr uint8_t) *)
(* cbData : DWORD -> 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 ("SetPrinterDataExA" set-printer-data-ex-a :convention :stdcall) :uint32
  (h-printer (:struct printer-handle))   ; PRINTER_HANDLE
  (p-key-name :string)   ; LPCSTR
  (p-value-name :string)   ; LPCSTR
  (type :uint32)   ; DWORD
  (p-data :pointer)   ; BYTE*
  (cb-data :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetPrinterDataExA = Win32::API::More->new('winspool.drv',
    'DWORD SetPrinterDataExA(LPVOID hPrinter, LPCSTR pKeyName, LPCSTR pValueName, DWORD Type, LPVOID pData, DWORD cbData)');
# my $ret = $SetPrinterDataExA->Call($hPrinter, $pKeyName, $pValueName, $Type, $pData, $cbData);
# hPrinter : PRINTER_HANDLE -> LPVOID
# pKeyName : LPCSTR -> LPCSTR
# pValueName : LPCSTR -> LPCSTR
# Type : DWORD -> DWORD
# pData : BYTE* -> LPVOID
# cbData : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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