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

SetPrinterDataW

関数
プリンタの構成データ値を設定する(Unicode版)。
DLLwinspool.drv文字セットUnicode (-W)呼出規約winapi

シグネチャ

// winspool.drv  (Unicode / -W)
#include <windows.h>

DWORD SetPrinterDataW(
    PRINTER_HANDLE hPrinter,
    LPCWSTR pValueName,
    DWORD Type,
    BYTE* pData,
    DWORD cbData
);

パラメーター

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

戻り値の型: DWORD

各言語での呼び出し定義

// winspool.drv  (Unicode / -W)
#include <windows.h>

DWORD SetPrinterDataW(
    PRINTER_HANDLE hPrinter,
    LPCWSTR pValueName,
    DWORD Type,
    BYTE* pData,
    DWORD cbData
);
[DllImport("winspool.drv", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint SetPrinterDataW(
    PRINTER_HANDLE hPrinter,   // PRINTER_HANDLE
    [MarshalAs(UnmanagedType.LPWStr)] string pValueName,   // LPCWSTR
    uint Type,   // DWORD
    IntPtr pData,   // BYTE*
    uint cbData   // DWORD
);
<DllImport("winspool.drv", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function SetPrinterDataW(
    hPrinter As PRINTER_HANDLE,   ' PRINTER_HANDLE
    <MarshalAs(UnmanagedType.LPWStr)> pValueName As String,   ' LPCWSTR
    Type As UInteger,   ' DWORD
    pData As IntPtr,   ' BYTE*
    cbData As UInteger   ' DWORD
) As UInteger
End Function
' hPrinter : PRINTER_HANDLE
' pValueName : LPCWSTR
' Type : DWORD
' pData : BYTE*
' cbData : DWORD
Declare PtrSafe Function SetPrinterDataW Lib "winspool.drv" ( _
    ByVal hPrinter As LongPtr, _
    ByVal pValueName As LongPtr, _
    ByVal Type As Long, _
    ByVal pData As LongPtr, _
    ByVal cbData As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetPrinterDataW = ctypes.windll.LoadLibrary("winspool.drv").SetPrinterDataW
SetPrinterDataW.restype = wintypes.DWORD
SetPrinterDataW.argtypes = [
    PRINTER_HANDLE,  # hPrinter : PRINTER_HANDLE
    wintypes.LPCWSTR,  # pValueName : LPCWSTR
    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')
SetPrinterDataW = Fiddle::Function.new(
  lib['SetPrinterDataW'],
  [
    Fiddle::TYPE_VOIDP,  # hPrinter : PRINTER_HANDLE
    Fiddle::TYPE_VOIDP,  # pValueName : LPCWSTR
    -Fiddle::TYPE_INT,  # Type : DWORD
    Fiddle::TYPE_VOIDP,  # pData : BYTE*
    -Fiddle::TYPE_INT,  # cbData : DWORD
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "winspool.drv")]
extern "system" {
    fn SetPrinterDataW(
        hPrinter: PRINTER_HANDLE,  // PRINTER_HANDLE
        pValueName: *const u16,  // LPCWSTR
        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.Unicode)]
public static extern uint SetPrinterDataW(PRINTER_HANDLE hPrinter, [MarshalAs(UnmanagedType.LPWStr)] string pValueName, uint Type, IntPtr pData, uint cbData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'winspool.drv_SetPrinterDataW' -Namespace Win32 -PassThru
# $api::SetPrinterDataW(hPrinter, pValueName, Type, pData, cbData)
#uselib "winspool.drv"
#func global SetPrinterDataW "SetPrinterDataW" wptr, wptr, wptr, wptr, wptr
; SetPrinterDataW hPrinter, pValueName, Type, varptr(pData), cbData   ; 戻り値は stat
; hPrinter : PRINTER_HANDLE -> "wptr"
; pValueName : LPCWSTR -> "wptr"
; Type : DWORD -> "wptr"
; pData : BYTE* -> "wptr"
; cbData : DWORD -> "wptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "winspool.drv"
#cfunc global SetPrinterDataW "SetPrinterDataW" int, wstr, int, var, int
; res = SetPrinterDataW(hPrinter, pValueName, Type, pData, cbData)
; hPrinter : PRINTER_HANDLE -> "int"
; pValueName : LPCWSTR -> "wstr"
; Type : DWORD -> "int"
; pData : BYTE* -> "var"
; cbData : DWORD -> "int"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD SetPrinterDataW(PRINTER_HANDLE hPrinter, LPCWSTR pValueName, DWORD Type, BYTE* pData, DWORD cbData)
#uselib "winspool.drv"
#cfunc global SetPrinterDataW "SetPrinterDataW" int, wstr, int, var, int
; res = SetPrinterDataW(hPrinter, pValueName, Type, pData, cbData)
; hPrinter : PRINTER_HANDLE -> "int"
; pValueName : LPCWSTR -> "wstr"
; 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")
	procSetPrinterDataW = winspool_drv.NewProc("SetPrinterDataW")
)

// hPrinter (PRINTER_HANDLE), pValueName (LPCWSTR), Type (DWORD), pData (BYTE*), cbData (DWORD)
r1, _, err := procSetPrinterDataW.Call(
	uintptr(hPrinter),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pValueName))),
	uintptr(Type),
	uintptr(pData),
	uintptr(cbData),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function SetPrinterDataW(
  hPrinter: PRINTER_HANDLE;   // PRINTER_HANDLE
  pValueName: PWideChar;   // LPCWSTR
  Type: DWORD;   // DWORD
  pData: Pointer;   // BYTE*
  cbData: DWORD   // DWORD
): DWORD; stdcall;
  external 'winspool.drv' name 'SetPrinterDataW';
result := DllCall("winspool.drv\SetPrinterDataW"
    , "Ptr", hPrinter   ; PRINTER_HANDLE
    , "WStr", pValueName   ; LPCWSTR
    , "UInt", Type   ; DWORD
    , "Ptr", pData   ; BYTE*
    , "UInt", cbData   ; DWORD
    , "UInt")   ; return: DWORD
●SetPrinterDataW(hPrinter, pValueName, Type, pData, cbData) = DLL("winspool.drv", "dword SetPrinterDataW(void*, char*, dword, void*, dword)")
# 呼び出し: SetPrinterDataW(hPrinter, pValueName, Type, pData, cbData)
# hPrinter : PRINTER_HANDLE -> "void*"
# pValueName : LPCWSTR -> "char*"
# Type : DWORD -> "dword"
# pData : BYTE* -> "void*"
# cbData : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "winspool.drv" fn SetPrinterDataW(
    hPrinter: PRINTER_HANDLE, // PRINTER_HANDLE
    pValueName: [*c]const u16, // LPCWSTR
    Type: u32, // DWORD
    pData: [*c]u8, // BYTE*
    cbData: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SetPrinterDataW(
    hPrinter: PRINTER_HANDLE,  # PRINTER_HANDLE
    pValueName: WideCString,  # LPCWSTR
    Type: uint32,  # DWORD
    pData: ptr uint8,  # BYTE*
    cbData: uint32  # DWORD
): uint32 {.importc: "SetPrinterDataW", stdcall, dynlib: "winspool.drv".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "winspool.drv");
extern(Windows)
uint SetPrinterDataW(
    PRINTER_HANDLE hPrinter,   // PRINTER_HANDLE
    const(wchar)* pValueName,   // LPCWSTR
    uint Type,   // DWORD
    ubyte* pData,   // BYTE*
    uint cbData   // DWORD
);
ccall((:SetPrinterDataW, "winspool.drv"), stdcall, UInt32,
      (PRINTER_HANDLE, Cwstring, UInt32, Ptr{UInt8}, UInt32),
      hPrinter, pValueName, Type, pData, cbData)
# hPrinter : PRINTER_HANDLE -> PRINTER_HANDLE
# pValueName : LPCWSTR -> Cwstring
# Type : DWORD -> UInt32
# pData : BYTE* -> Ptr{UInt8}
# cbData : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t SetPrinterDataW(
    PRINTER_HANDLE hPrinter,
    const uint16_t* pValueName,
    uint32_t Type,
    uint8_t* pData,
    uint32_t cbData);
]]
local winspool.drv = ffi.load("winspool.drv")
-- winspool.drv.SetPrinterDataW(hPrinter, pValueName, Type, pData, cbData)
-- hPrinter : PRINTER_HANDLE
-- pValueName : LPCWSTR
-- Type : DWORD
-- pData : BYTE*
-- cbData : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('winspool.drv');
const SetPrinterDataW = lib.func('__stdcall', 'SetPrinterDataW', 'uint32_t', ['PRINTER_HANDLE', 'str16', 'uint32_t', 'uint8_t *', 'uint32_t']);
// SetPrinterDataW(hPrinter, pValueName, Type, pData, cbData)
// hPrinter : PRINTER_HANDLE -> 'PRINTER_HANDLE'
// pValueName : LPCWSTR -> 'str16'
// Type : DWORD -> 'uint32_t'
// pData : BYTE* -> 'uint8_t *'
// cbData : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("winspool.drv", {
  SetPrinterDataW: { parameters: ["buffer", "buffer", "u32", "pointer", "u32"], result: "u32" },
});
// lib.symbols.SetPrinterDataW(hPrinter, pValueName, Type, pData, cbData)
// hPrinter : PRINTER_HANDLE -> "buffer"
// pValueName : LPCWSTR -> "buffer"
// Type : DWORD -> "u32"
// pData : BYTE* -> "pointer"
// cbData : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t SetPrinterDataW(
    PRINTER_HANDLE hPrinter,
    const uint16_t* pValueName,
    uint32_t Type,
    uint8_t* pData,
    uint32_t cbData);
C, "winspool.drv");
// $ffi->SetPrinterDataW(hPrinter, pValueName, Type, pData, cbData);
// hPrinter : PRINTER_HANDLE
// pValueName : LPCWSTR
// 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.UNICODE_OPTIONS);
    int SetPrinterDataW(
        PRINTER_HANDLE /* extends Structure (by value) */ hPrinter,   // PRINTER_HANDLE
        WString pValueName,   // LPCWSTR
        int Type,   // DWORD
        byte[] pData,   // BYTE*
        int cbData   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("winspool.drv")]
lib Libwinspool.drv
  fun SetPrinterDataW = SetPrinterDataW(
    hPrinter : PRINTER_HANDLE,   # PRINTER_HANDLE
    pValueName : UInt16*,   # LPCWSTR
    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 SetPrinterDataWNative = Uint32 Function(PRINTER_HANDLE, Pointer<Utf16>, Uint32, Pointer<Uint8>, Uint32);
typedef SetPrinterDataWDart = int Function(int, Pointer<Utf16>, int, Pointer<Uint8>, int);
final SetPrinterDataW = DynamicLibrary.open('winspool.drv')
    .lookupFunction<SetPrinterDataWNative, SetPrinterDataWDart>('SetPrinterDataW');
// hPrinter : PRINTER_HANDLE -> PRINTER_HANDLE
// pValueName : LPCWSTR -> Pointer<Utf16>
// Type : DWORD -> Uint32
// pData : BYTE* -> Pointer<Uint8>
// cbData : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetPrinterDataW(
  hPrinter: PRINTER_HANDLE;   // PRINTER_HANDLE
  pValueName: PWideChar;   // LPCWSTR
  Type: DWORD;   // DWORD
  pData: Pointer;   // BYTE*
  cbData: DWORD   // DWORD
): DWORD; stdcall;
  external 'winspool.drv' name 'SetPrinterDataW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetPrinterDataW"
  c_SetPrinterDataW :: PRINTER_HANDLE -> CWString -> Word32 -> Ptr Word8 -> Word32 -> IO Word32
-- hPrinter : PRINTER_HANDLE -> PRINTER_HANDLE
-- pValueName : LPCWSTR -> CWString
-- 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 setprinterdataw =
  foreign "SetPrinterDataW"
    (PRINTER_HANDLE @-> (ptr uint16_t) @-> uint32_t @-> (ptr uint8_t) @-> uint32_t @-> returning uint32_t)
(* hPrinter : PRINTER_HANDLE -> PRINTER_HANDLE *)
(* pValueName : LPCWSTR -> (ptr uint16_t) *)
(* 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 ("SetPrinterDataW" set-printer-data-w :convention :stdcall) :uint32
  (h-printer (:struct printer-handle))   ; PRINTER_HANDLE
  (p-value-name (:string :encoding :utf-16le))   ; LPCWSTR
  (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 $SetPrinterDataW = Win32::API::More->new('winspool.drv',
    'DWORD SetPrinterDataW(LPVOID hPrinter, LPCWSTR pValueName, DWORD Type, LPVOID pData, DWORD cbData)');
# my $ret = $SetPrinterDataW->Call($hPrinter, $pValueName, $Type, $pData, $cbData);
# hPrinter : PRINTER_HANDLE -> LPVOID
# pValueName : LPCWSTR -> LPCWSTR
# Type : DWORD -> DWORD
# pData : BYTE* -> LPVOID
# cbData : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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