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

SetPortW

関数
プリンターポートの構成情報を設定する。
DLLwinspool.drv文字セットUnicode (-W)呼出規約winapiSetLastErrorあり

シグネチャ

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

BOOL SetPortW(
    LPWSTR pName,   // optional
    LPWSTR pPortName,
    DWORD dwLevel,
    BYTE* pPortInfo
);

パラメーター

名前方向説明
pNameLPWSTRinoptional対象サーバー名を指すポインタ。ローカルならNULLを指定する。
pPortNameLPWSTRin設定変更するポートの名前を指すポインタ。
dwLevelDWORDinpPortInfoが指す構造体のレベル。3を指定する。
pPortInfoBYTE*inポートの状態情報を格納したPORT_INFO_3構造体へのポインタ。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL SetPortW(
    LPWSTR pName,   // optional
    LPWSTR pPortName,
    DWORD dwLevel,
    BYTE* pPortInfo
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("winspool.drv", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool SetPortW(
    [MarshalAs(UnmanagedType.LPWStr)] string pName,   // LPWSTR optional
    [MarshalAs(UnmanagedType.LPWStr)] string pPortName,   // LPWSTR
    uint dwLevel,   // DWORD
    IntPtr pPortInfo   // BYTE*
);
<DllImport("winspool.drv", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetPortW(
    <MarshalAs(UnmanagedType.LPWStr)> pName As String,   ' LPWSTR optional
    <MarshalAs(UnmanagedType.LPWStr)> pPortName As String,   ' LPWSTR
    dwLevel As UInteger,   ' DWORD
    pPortInfo As IntPtr   ' BYTE*
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' pName : LPWSTR optional
' pPortName : LPWSTR
' dwLevel : DWORD
' pPortInfo : BYTE*
Declare PtrSafe Function SetPortW Lib "winspool.drv" ( _
    ByVal pName As LongPtr, _
    ByVal pPortName As LongPtr, _
    ByVal dwLevel As Long, _
    ByVal pPortInfo As LongPtr) 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

SetPortW = ctypes.windll.LoadLibrary("winspool.drv").SetPortW
SetPortW.restype = wintypes.BOOL
SetPortW.argtypes = [
    wintypes.LPCWSTR,  # pName : LPWSTR optional
    wintypes.LPCWSTR,  # pPortName : LPWSTR
    wintypes.DWORD,  # dwLevel : DWORD
    ctypes.POINTER(ctypes.c_ubyte),  # pPortInfo : BYTE*
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('winspool.drv')
SetPortW = Fiddle::Function.new(
  lib['SetPortW'],
  [
    Fiddle::TYPE_VOIDP,  # pName : LPWSTR optional
    Fiddle::TYPE_VOIDP,  # pPortName : LPWSTR
    -Fiddle::TYPE_INT,  # dwLevel : DWORD
    Fiddle::TYPE_VOIDP,  # pPortInfo : BYTE*
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "winspool.drv")]
extern "system" {
    fn SetPortW(
        pName: *mut u16,  // LPWSTR optional
        pPortName: *mut u16,  // LPWSTR
        dwLevel: u32,  // DWORD
        pPortInfo: *mut u8  // BYTE*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("winspool.drv", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool SetPortW([MarshalAs(UnmanagedType.LPWStr)] string pName, [MarshalAs(UnmanagedType.LPWStr)] string pPortName, uint dwLevel, IntPtr pPortInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'winspool.drv_SetPortW' -Namespace Win32 -PassThru
# $api::SetPortW(pName, pPortName, dwLevel, pPortInfo)
#uselib "winspool.drv"
#func global SetPortW "SetPortW" wptr, wptr, wptr, wptr
; SetPortW pName, pPortName, dwLevel, varptr(pPortInfo)   ; 戻り値は stat
; pName : LPWSTR optional -> "wptr"
; pPortName : LPWSTR -> "wptr"
; dwLevel : DWORD -> "wptr"
; pPortInfo : BYTE* -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "winspool.drv"
#cfunc global SetPortW "SetPortW" wstr, wstr, int, var
; res = SetPortW(pName, pPortName, dwLevel, pPortInfo)
; pName : LPWSTR optional -> "wstr"
; pPortName : LPWSTR -> "wstr"
; dwLevel : DWORD -> "int"
; pPortInfo : BYTE* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL SetPortW(LPWSTR pName, LPWSTR pPortName, DWORD dwLevel, BYTE* pPortInfo)
#uselib "winspool.drv"
#cfunc global SetPortW "SetPortW" wstr, wstr, int, var
; res = SetPortW(pName, pPortName, dwLevel, pPortInfo)
; pName : LPWSTR optional -> "wstr"
; pPortName : LPWSTR -> "wstr"
; dwLevel : DWORD -> "int"
; pPortInfo : BYTE* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winspool_drv = windows.NewLazySystemDLL("winspool.drv")
	procSetPortW = winspool_drv.NewProc("SetPortW")
)

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

extern "winspool.drv" fn SetPortW(
    pName: [*c]const u16, // LPWSTR optional
    pPortName: [*c]const u16, // LPWSTR
    dwLevel: u32, // DWORD
    pPortInfo: [*c]u8 // BYTE*
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc SetPortW(
    pName: WideCString,  # LPWSTR optional
    pPortName: WideCString,  # LPWSTR
    dwLevel: uint32,  # DWORD
    pPortInfo: ptr uint8  # BYTE*
): int32 {.importc: "SetPortW", stdcall, dynlib: "winspool.drv".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "winspool.drv");
extern(Windows)
int SetPortW(
    const(wchar)* pName,   // LPWSTR optional
    const(wchar)* pPortName,   // LPWSTR
    uint dwLevel,   // DWORD
    ubyte* pPortInfo   // BYTE*
);
ccall((:SetPortW, "winspool.drv"), stdcall, Int32,
      (Cwstring, Cwstring, UInt32, Ptr{UInt8}),
      pName, pPortName, dwLevel, pPortInfo)
# pName : LPWSTR optional -> Cwstring
# pPortName : LPWSTR -> Cwstring
# dwLevel : DWORD -> UInt32
# pPortInfo : BYTE* -> Ptr{UInt8}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetPortW(
    const uint16_t* pName,
    const uint16_t* pPortName,
    uint32_t dwLevel,
    uint8_t* pPortInfo);
]]
local winspool.drv = ffi.load("winspool.drv")
-- winspool.drv.SetPortW(pName, pPortName, dwLevel, pPortInfo)
-- pName : LPWSTR optional
-- pPortName : LPWSTR
-- dwLevel : DWORD
-- pPortInfo : BYTE*
-- 構造体/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 SetPortW = lib.func('__stdcall', 'SetPortW', 'int32_t', ['str16', 'str16', 'uint32_t', 'uint8_t *']);
// SetPortW(pName, pPortName, dwLevel, pPortInfo)
// pName : LPWSTR optional -> 'str16'
// pPortName : LPWSTR -> 'str16'
// dwLevel : DWORD -> 'uint32_t'
// pPortInfo : BYTE* -> 'uint8_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("winspool.drv", {
  SetPortW: { parameters: ["buffer", "buffer", "u32", "pointer"], result: "i32" },
});
// lib.symbols.SetPortW(pName, pPortName, dwLevel, pPortInfo)
// pName : LPWSTR optional -> "buffer"
// pPortName : LPWSTR -> "buffer"
// dwLevel : DWORD -> "u32"
// pPortInfo : BYTE* -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetPortW(
    const uint16_t* pName,
    const uint16_t* pPortName,
    uint32_t dwLevel,
    uint8_t* pPortInfo);
C, "winspool.drv");
// $ffi->SetPortW(pName, pPortName, dwLevel, pPortInfo);
// pName : LPWSTR optional
// pPortName : LPWSTR
// dwLevel : DWORD
// pPortInfo : BYTE*
// 構造体/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);
    boolean SetPortW(
        WString pName,   // LPWSTR optional
        WString pPortName,   // LPWSTR
        int dwLevel,   // DWORD
        byte[] pPortInfo   // BYTE*
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("winspool.drv")]
lib Libwinspool.drv
  fun SetPortW = SetPortW(
    pName : UInt16*,   # LPWSTR optional
    pPortName : UInt16*,   # LPWSTR
    dwLevel : UInt32,   # DWORD
    pPortInfo : UInt8*   # BYTE*
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetPortWNative = Int32 Function(Pointer<Utf16>, Pointer<Utf16>, Uint32, Pointer<Uint8>);
typedef SetPortWDart = int Function(Pointer<Utf16>, Pointer<Utf16>, int, Pointer<Uint8>);
final SetPortW = DynamicLibrary.open('winspool.drv')
    .lookupFunction<SetPortWNative, SetPortWDart>('SetPortW');
// pName : LPWSTR optional -> Pointer<Utf16>
// pPortName : LPWSTR -> Pointer<Utf16>
// dwLevel : DWORD -> Uint32
// pPortInfo : BYTE* -> Pointer<Uint8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetPortW(
  pName: PWideChar;   // LPWSTR optional
  pPortName: PWideChar;   // LPWSTR
  dwLevel: DWORD;   // DWORD
  pPortInfo: Pointer   // BYTE*
): BOOL; stdcall;
  external 'winspool.drv' name 'SetPortW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetPortW"
  c_SetPortW :: CWString -> CWString -> Word32 -> Ptr Word8 -> IO CInt
-- pName : LPWSTR optional -> CWString
-- pPortName : LPWSTR -> CWString
-- dwLevel : DWORD -> Word32
-- pPortInfo : BYTE* -> Ptr Word8
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setportw =
  foreign "SetPortW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> (ptr uint8_t) @-> returning int32_t)
(* pName : LPWSTR optional -> (ptr uint16_t) *)
(* pPortName : LPWSTR -> (ptr uint16_t) *)
(* dwLevel : DWORD -> uint32_t *)
(* pPortInfo : BYTE* -> (ptr uint8_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 ("SetPortW" set-port-w :convention :stdcall) :int32
  (p-name (:string :encoding :utf-16le))   ; LPWSTR optional
  (p-port-name (:string :encoding :utf-16le))   ; LPWSTR
  (dw-level :uint32)   ; DWORD
  (p-port-info :pointer))   ; BYTE*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetPortW = Win32::API::More->new('winspool.drv',
    'BOOL SetPortW(LPCWSTR pName, LPCWSTR pPortName, DWORD dwLevel, LPVOID pPortInfo)');
# my $ret = $SetPortW->Call($pName, $pPortName, $dwLevel, $pPortInfo);
# pName : LPWSTR optional -> LPCWSTR
# pPortName : LPWSTR -> LPCWSTR
# dwLevel : DWORD -> DWORD
# pPortInfo : BYTE* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い