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

SetPortA

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

シグネチャ

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

BOOL SetPortA(
    LPSTR pName,   // optional
    LPSTR pPortName,
    DWORD dwLevel,
    BYTE* pPortInfo
);

パラメーター

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

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL SetPortA(
    LPSTR pName,   // optional
    LPSTR pPortName,
    DWORD dwLevel,
    BYTE* pPortInfo
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("winspool.drv", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool SetPortA(
    [MarshalAs(UnmanagedType.LPStr)] string pName,   // LPSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string pPortName,   // LPSTR
    uint dwLevel,   // DWORD
    IntPtr pPortInfo   // BYTE*
);
<DllImport("winspool.drv", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetPortA(
    <MarshalAs(UnmanagedType.LPStr)> pName As String,   ' LPSTR optional
    <MarshalAs(UnmanagedType.LPStr)> pPortName As String,   ' LPSTR
    dwLevel As UInteger,   ' DWORD
    pPortInfo As IntPtr   ' BYTE*
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' pName : LPSTR optional
' pPortName : LPSTR
' dwLevel : DWORD
' pPortInfo : BYTE*
Declare PtrSafe Function SetPortA Lib "winspool.drv" ( _
    ByVal pName As String, _
    ByVal pPortName As String, _
    ByVal dwLevel As Long, _
    ByVal pPortInfo As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetPortA = ctypes.windll.LoadLibrary("winspool.drv").SetPortA
SetPortA.restype = wintypes.BOOL
SetPortA.argtypes = [
    wintypes.LPCSTR,  # pName : LPSTR optional
    wintypes.LPCSTR,  # pPortName : LPSTR
    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')
SetPortA = Fiddle::Function.new(
  lib['SetPortA'],
  [
    Fiddle::TYPE_VOIDP,  # pName : LPSTR optional
    Fiddle::TYPE_VOIDP,  # pPortName : LPSTR
    -Fiddle::TYPE_INT,  # dwLevel : DWORD
    Fiddle::TYPE_VOIDP,  # pPortInfo : BYTE*
  ],
  Fiddle::TYPE_INT)
#[link(name = "winspool.drv")]
extern "system" {
    fn SetPortA(
        pName: *mut u8,  // LPSTR optional
        pPortName: *mut u8,  // LPSTR
        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.Ansi, SetLastError = true)]
public static extern bool SetPortA([MarshalAs(UnmanagedType.LPStr)] string pName, [MarshalAs(UnmanagedType.LPStr)] string pPortName, uint dwLevel, IntPtr pPortInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'winspool.drv_SetPortA' -Namespace Win32 -PassThru
# $api::SetPortA(pName, pPortName, dwLevel, pPortInfo)
#uselib "winspool.drv"
#func global SetPortA "SetPortA" sptr, sptr, sptr, sptr
; SetPortA pName, pPortName, dwLevel, varptr(pPortInfo)   ; 戻り値は stat
; pName : LPSTR optional -> "sptr"
; pPortName : LPSTR -> "sptr"
; dwLevel : DWORD -> "sptr"
; pPortInfo : BYTE* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "winspool.drv"
#cfunc global SetPortA "SetPortA" str, str, int, var
; res = SetPortA(pName, pPortName, dwLevel, pPortInfo)
; pName : LPSTR optional -> "str"
; pPortName : LPSTR -> "str"
; dwLevel : DWORD -> "int"
; pPortInfo : BYTE* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL SetPortA(LPSTR pName, LPSTR pPortName, DWORD dwLevel, BYTE* pPortInfo)
#uselib "winspool.drv"
#cfunc global SetPortA "SetPortA" str, str, int, var
; res = SetPortA(pName, pPortName, dwLevel, pPortInfo)
; pName : LPSTR optional -> "str"
; pPortName : LPSTR -> "str"
; dwLevel : DWORD -> "int"
; pPortInfo : BYTE* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winspool_drv = windows.NewLazySystemDLL("winspool.drv")
	procSetPortA = winspool_drv.NewProc("SetPortA")
)

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

extern "winspool.drv" fn SetPortA(
    pName: [*c]const u8, // LPSTR optional
    pPortName: [*c]const u8, // LPSTR
    dwLevel: u32, // DWORD
    pPortInfo: [*c]u8 // BYTE*
) callconv(std.os.windows.WINAPI) i32;
proc SetPortA(
    pName: cstring,  # LPSTR optional
    pPortName: cstring,  # LPSTR
    dwLevel: uint32,  # DWORD
    pPortInfo: ptr uint8  # BYTE*
): int32 {.importc: "SetPortA", stdcall, dynlib: "winspool.drv".}
pragma(lib, "winspool.drv");
extern(Windows)
int SetPortA(
    const(char)* pName,   // LPSTR optional
    const(char)* pPortName,   // LPSTR
    uint dwLevel,   // DWORD
    ubyte* pPortInfo   // BYTE*
);
ccall((:SetPortA, "winspool.drv"), stdcall, Int32,
      (Cstring, Cstring, UInt32, Ptr{UInt8}),
      pName, pPortName, dwLevel, pPortInfo)
# pName : LPSTR optional -> Cstring
# pPortName : LPSTR -> Cstring
# dwLevel : DWORD -> UInt32
# pPortInfo : BYTE* -> Ptr{UInt8}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetPortA(
    const char* pName,
    const char* pPortName,
    uint32_t dwLevel,
    uint8_t* pPortInfo);
]]
local winspool.drv = ffi.load("winspool.drv")
-- winspool.drv.SetPortA(pName, pPortName, dwLevel, pPortInfo)
-- pName : LPSTR optional
-- pPortName : LPSTR
-- dwLevel : DWORD
-- pPortInfo : BYTE*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('winspool.drv');
const SetPortA = lib.func('__stdcall', 'SetPortA', 'int32_t', ['str', 'str', 'uint32_t', 'uint8_t *']);
// SetPortA(pName, pPortName, dwLevel, pPortInfo)
// pName : LPSTR optional -> 'str'
// pPortName : LPSTR -> 'str'
// dwLevel : DWORD -> 'uint32_t'
// pPortInfo : BYTE* -> 'uint8_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("winspool.drv", {
  SetPortA: { parameters: ["buffer", "buffer", "u32", "pointer"], result: "i32" },
});
// lib.symbols.SetPortA(pName, pPortName, dwLevel, pPortInfo)
// pName : LPSTR optional -> "buffer"
// pPortName : LPSTR -> "buffer"
// dwLevel : DWORD -> "u32"
// pPortInfo : BYTE* -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetPortA(
    const char* pName,
    const char* pPortName,
    uint32_t dwLevel,
    uint8_t* pPortInfo);
C, "winspool.drv");
// $ffi->SetPortA(pName, pPortName, dwLevel, pPortInfo);
// pName : LPSTR optional
// pPortName : LPSTR
// 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.ASCII_OPTIONS);
    boolean SetPortA(
        String pName,   // LPSTR optional
        String pPortName,   // LPSTR
        int dwLevel,   // DWORD
        byte[] pPortInfo   // BYTE*
    );
}
@[Link("winspool.drv")]
lib Libwinspool.drv
  fun SetPortA = SetPortA(
    pName : UInt8*,   # LPSTR optional
    pPortName : UInt8*,   # LPSTR
    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 SetPortANative = Int32 Function(Pointer<Utf8>, Pointer<Utf8>, Uint32, Pointer<Uint8>);
typedef SetPortADart = int Function(Pointer<Utf8>, Pointer<Utf8>, int, Pointer<Uint8>);
final SetPortA = DynamicLibrary.open('winspool.drv')
    .lookupFunction<SetPortANative, SetPortADart>('SetPortA');
// pName : LPSTR optional -> Pointer<Utf8>
// pPortName : LPSTR -> Pointer<Utf8>
// dwLevel : DWORD -> Uint32
// pPortInfo : BYTE* -> Pointer<Uint8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetPortA(
  pName: PAnsiChar;   // LPSTR optional
  pPortName: PAnsiChar;   // LPSTR
  dwLevel: DWORD;   // DWORD
  pPortInfo: Pointer   // BYTE*
): BOOL; stdcall;
  external 'winspool.drv' name 'SetPortA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let setporta =
  foreign "SetPortA"
    (string @-> string @-> uint32_t @-> (ptr uint8_t) @-> returning int32_t)
(* pName : LPSTR optional -> string *)
(* pPortName : LPSTR -> string *)
(* 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 ("SetPortA" set-port-a :convention :stdcall) :int32
  (p-name :string)   ; LPSTR optional
  (p-port-name :string)   ; LPSTR
  (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 $SetPortA = Win32::API::More->new('winspool.drv',
    'BOOL SetPortA(LPCSTR pName, LPCSTR pPortName, DWORD dwLevel, LPVOID pPortInfo)');
# my $ret = $SetPortA->Call($pName, $pPortName, $dwLevel, $pPortInfo);
# pName : LPSTR optional -> LPCSTR
# pPortName : LPSTR -> LPCSTR
# dwLevel : DWORD -> DWORD
# pPortInfo : BYTE* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い