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

PRINTER_NOTIFY_INFO_DATA

構造体
サイズx64: 24 バイト / x86: 20 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールドサイズx64x86説明
TypeWORD2+0+0通知対象の種別を示す値(PRINTER_NOTIFY_TYPE/JOB_NOTIFY_TYPE)。
FieldWORD2+2+2変更されたフィールドの識別子。
ReservedDWORD4+4+4予約フィールド。0を設定する。
IdDWORD4+8+8変更が発生した対象(ジョブID等)の識別子。
NotifyData_NotifyData_e__Union8+16+12変更後の値を保持する無名共用体(整数/文字列/バイナリ)。

共用体: _NotifyData_e__Union x64 8B / x86 8B

フィールドサイズx64x86
adwDataDWORD8+0+0
Data_Data_e__Struct8/4+0+0

公式ドキュメント

PRINTER_NOTIFY_INFO_DATA 構造体は、ジョブまたはプリンターの情報フィールドを識別し、そのフィールドの現在のデータを提供します。

FindNextPrinterChangeNotification 関数は PRINTER_NOTIFY_INFO 構造体を返します。この構造体には PRINTER_NOTIFY_INFO_DATA 構造体の配列が含まれます。

解説(Remarks)

Type メンバーが PRINTER_NOTIFY_TYPE を指定している場合、Field メンバーには次のいずれかの値を指定できます。

フィールド データの種類
PRINTER_NOTIFY_FIELD_SERVER_NAME サポートされていません。 0x00
PRINTER_NOTIFY_FIELD_PRINTER_NAME pBuf は、プリンターの名前を格納した null 終端文字列へのポインターです。 0x01
PRINTER_NOTIFY_FIELD_SHARE_NAME pBuf は、プリンターの共有ポイントを示す null 終端文字列へのポインターです。 0x02
PRINTER_NOTIFY_FIELD_PORT_NAME pBuf は、印刷ジョブの出力先となるポートの名前を格納した null 終端文字列へのポインターです。"プリンター プール" が選択されている場合は、カンマ区切りのポートの一覧になります。 0x03
PRINTER_NOTIFY_FIELD_DRIVER_NAME pBuf は、プリンターのドライバーの名前を格納した null 終端文字列へのポインターです。 0x04
PRINTER_NOTIFY_FIELD_COMMENT pBuf は、新しいコメント文字列を格納した null 終端文字列へのポインターです。通常はプリンターの簡単な説明です。 0x05
PRINTER_NOTIFY_FIELD_LOCATION pBuf は、プリンターの新しい物理的な設置場所を格納した null 終端文字列へのポインターです (例: "Bldg. 38, Room 1164")。 0x06
PRINTER_NOTIFY_FIELD_DEVMODE pBuf は、用紙の向きや解像度などの既定のプリンター データを定義する DEVMODE 構造体へのポインターです。 0x07
PRINTER_NOTIFY_FIELD_SEPFILE pBuf は、区切りページの作成に使用されるファイルの名前を指定する null 終端文字列へのポインターです。このページは、プリンターに送信された印刷ジョブを区切るために使用されます。 0x08
PRINTER_NOTIFY_FIELD_PRINT_PROCESSOR pBuf は、プリンターが使用する印刷プロセッサの名前を指定する null 終端文字列へのポインターです。 0x09
PRINTER_NOTIFY_FIELD_PARAMETERS pBuf は、既定の印刷プロセッサ パラメーターを指定する null 終端文字列へのポインターです。 0x0A
PRINTER_NOTIFY_FIELD_DATATYPE pBuf は、印刷ジョブの記録に使用されるデータ型を指定する null 終端文字列へのポインターです。 0x0B
PRINTER_NOTIFY_FIELD_SECURITY_DESCRIPTOR pBuf は、プリンターの SECURITY_DESCRIPTOR 構造体へのポインターです。セキュリティ記述子が存在しない場合、このポインターは NULL になることがあります。 0x0C
PRINTER_NOTIFY_FIELD_ATTRIBUTES adwData [0] は、プリンターの属性を指定します。次のいずれかの値を指定できます:
PRINTER_ATTRIBUTE_QUEUED
PRINTER_ATTRIBUTE_DIRECT
PRINTER_ATTRIBUTE_DEFAULT
PRINTER_ATTRIBUTE_SHARED
0x0D
PRINTER_NOTIFY_FIELD_PRIORITY adwData [0] は、スプーラーが印刷ジョブの振り分けに使用する優先度の値を指定します。 0x0E
PRINTER_NOTIFY_FIELD_DEFAULT_PRIORITY adwData [0] は、各印刷ジョブに割り当てられる既定の優先度の値を指定します。 0x0F
PRINTER_NOTIFY_FIELD_START_TIME adwData [0] は、プリンターがジョブを印刷できる最も早い時刻を指定します (この値は午前 0 時からの経過分数で指定されます)。 0x10
PRINTER_NOTIFY_FIELD_UNTIL_TIME adwData [0] は、プリンターがジョブを印刷できる最も遅い時刻を指定します (この値は午前 0 時からの経過分数で指定されます)。 0x11
PRINTER_NOTIFY_FIELD_STATUS adwData [0] は、プリンターの状態を指定します。指定できる値の一覧については、PRINTER_INFO_2 構造体を参照してください。 0x12
PRINTER_NOTIFY_FIELD_STATUS_STRING サポートされていません。 0x13
PRINTER_NOTIFY_FIELD_CJOBS adwData [0] は、プリンターのキューに入れられた印刷ジョブの数を指定します。 0x14
PRINTER_NOTIFY_FIELD_AVERAGE_PPM adwData [0] は、そのプリンターで印刷された 1 分あたりの平均ページ数を指定します。 0x15
PRINTER_NOTIFY_FIELD_TOTAL_PAGES サポートされていません。 0x16
PRINTER_NOTIFY_FIELD_PAGES_PRINTED サポートされていません。 0x17
PRINTER_NOTIFY_FIELD_TOTAL_BYTES サポートされていません。 0x18
PRINTER_NOTIFY_FIELD_BYTES_PRINTED サポートされていません。 0x19
PRINTER_NOTIFY_FIELD_OBJECT_GUID オブジェクトの GUID が変更された場合に設定されます。 0x1A
PRINTER_NOTIFY_FIELD_FRIENDLY_NAME プリンター接続の名前が変更された場合に設定されます。 0x1B

Type メンバーが JOB_NOTIFY_TYPE を指定している場合、Field メンバーには次のいずれかの値を指定できます。

フィールド データの種類
JOB_NOTIFY_FIELD_PRINTER_NAME pBuf は、ジョブがスプールされているプリンターの名前を格納した null 終端文字列へのポインターです。 0x00
JOB_NOTIFY_FIELD_MACHINE_NAME pBuf は、印刷ジョブを作成したコンピューターの名前を指定する null 終端文字列へのポインターです。 0x01
JOB_NOTIFY_FIELD_PORT_NAME pBuf は、プリンターへのデータ送信に使用されるポートを示す null 終端文字列へのポインターです。プリンターが複数のポートに接続されている場合、ポート名はカンマで区切られます (例: "LPT1:,LPT2:,LPT3:")。 0x02
JOB_NOTIFY_FIELD_USER_NAME pBuf は、印刷ジョブを送信したユーザーの名前を指定する null 終端文字列へのポインターです。 0x03
JOB_NOTIFY_FIELD_NOTIFY_NAME pBuf は、ジョブの印刷が完了したとき、またはジョブの印刷中にエラーが発生したときに通知すべきユーザーの名前を指定する null 終端文字列へのポインターです。 0x04
JOB_NOTIFY_FIELD_DATATYPE pBuf は、印刷ジョブの記録に使用されるデータの種類を指定する null 終端文字列へのポインターです。 0x05
JOB_NOTIFY_FIELD_PRINT_PROCESSOR pBuf は、ジョブの印刷に使用される印刷プロセッサの名前を指定する null 終端文字列へのポインターです。 0x06
JOB_NOTIFY_FIELD_PARAMETERS pBuf は、印刷プロセッサ パラメーターを指定する null 終端文字列へのポインターです。 0x07
JOB_NOTIFY_FIELD_DRIVER_NAME pBuf は、印刷ジョブの処理に使用されるプリンター ドライバーの名前を指定する null 終端文字列へのポインターです。 0x08
JOB_NOTIFY_FIELD_DEVMODE pBuf は、プリンター ドライバーのデバイス初期化データおよび環境データを格納した DEVMODE 構造体へのポインターです。 0x09
JOB_NOTIFY_FIELD_STATUS adwData [0] は、ジョブの状態を指定します。指定できる値の一覧については、JOB_INFO_2 構造体を参照してください。 0x0A
JOB_NOTIFY_FIELD_STATUS_STRING pBuf は、印刷ジョブの状態を指定する null 終端文字列へのポインターです。 0x0B
JOB_NOTIFY_FIELD_SECURITY_DESCRIPTOR サポートされていません。 0x0C
JOB_NOTIFY_FIELD_DOCUMENT pBuf は、印刷ジョブの名前を指定する null 終端文字列へのポインターです (例: "MS-WORD: Review.doc")。 0x0D
JOB_NOTIFY_FIELD_PRIORITY adwData [0] は、ジョブの優先度を指定します。 0x0E
JOB_NOTIFY_FIELD_POSITION adwData [0] は、印刷キュー内でのジョブの位置を指定します。 0x0F
JOB_NOTIFY_FIELD_SUBMITTED pBuf は、ジョブが送信された時刻を示す SYSTEMTIME 構造体へのポインターです。 0x10
JOB_NOTIFY_FIELD_START_TIME adwData [0] は、ジョブを印刷できる最も早い時刻を指定します (この値は午前 0 時からの経過分数で指定されます)。 0x11
JOB_NOTIFY_FIELD_UNTIL_TIME adwData [0] は、ジョブを印刷できる最も遅い時刻を指定します (この値は午前 0 時からの経過分数で指定されます)。 0x12
JOB_NOTIFY_FIELD_TIME adwData [0] は、ジョブの印刷が開始されてからの経過時間の合計を秒単位で指定します。 0x13
JOB_NOTIFY_FIELD_TOTAL_PAGES adwData [0] は、ジョブのサイズをページ単位で指定します。 0x14
JOB_NOTIFY_FIELD_PAGES_PRINTED adwData [0] は、印刷済みのページ数を指定します。 0x15
JOB_NOTIFY_FIELD_TOTAL_BYTES adwData [0] は、ジョブのサイズをバイト単位で指定します。 0x16
JOB_NOTIFY_FIELD_BYTES_PRINTED adwData [0] は、このジョブで印刷済みのバイト数を指定します。このフィールドでは、バイトがプリンターに送信されたときに変更通知オブジェクトがシグナル状態になります。 0x17
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp)

各言語での定義

#include <windows.h>

// PRINTER_NOTIFY_INFO_DATA  (x64 24 / x86 20 バイト)
typedef struct PRINTER_NOTIFY_INFO_DATA {
    WORD Type;
    WORD Field;
    DWORD Reserved;
    DWORD Id;
    _NotifyData_e__Union NotifyData;
} PRINTER_NOTIFY_INFO_DATA;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct PRINTER_NOTIFY_INFO_DATA
{
    public ushort Type;
    public ushort Field;
    public uint Reserved;
    public uint Id;
    public _NotifyData_e__Union NotifyData;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure PRINTER_NOTIFY_INFO_DATA
    Public Type As UShort
    Public Field As UShort
    Public Reserved As UInteger
    Public Id As UInteger
    Public NotifyData As _NotifyData_e__Union
End Structure
import ctypes
from ctypes import wintypes

class PRINTER_NOTIFY_INFO_DATA(ctypes.Structure):
    _fields_ = [
        ("Type", ctypes.c_ushort),
        ("Field", ctypes.c_ushort),
        ("Reserved", wintypes.DWORD),
        ("Id", wintypes.DWORD),
        ("NotifyData", _NotifyData_e__Union),
    ]
#[repr(C)]
pub struct PRINTER_NOTIFY_INFO_DATA {
    pub Type: u16,
    pub Field: u16,
    pub Reserved: u32,
    pub Id: u32,
    pub NotifyData: _NotifyData_e__Union,
}
import "golang.org/x/sys/windows"

type PRINTER_NOTIFY_INFO_DATA struct {
	Type uint16
	Field uint16
	Reserved uint32
	Id uint32
	NotifyData _NotifyData_e__Union
}
type
  PRINTER_NOTIFY_INFO_DATA = record
    Type: Word;
    Field: Word;
    Reserved: DWORD;
    Id: DWORD;
    NotifyData: _NotifyData_e__Union;
  end;
const PRINTER_NOTIFY_INFO_DATA = extern struct {
    Type: u16,
    Field: u16,
    Reserved: u32,
    Id: u32,
    NotifyData: _NotifyData_e__Union,
};
type
  PRINTER_NOTIFY_INFO_DATA {.bycopy.} = object
    Type: uint16
    Field: uint16
    Reserved: uint32
    Id: uint32
    NotifyData: _NotifyData_e__Union
struct PRINTER_NOTIFY_INFO_DATA
{
    ushort Type;
    ushort Field;
    uint Reserved;
    uint Id;
    _NotifyData_e__Union NotifyData;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; PRINTER_NOTIFY_INFO_DATA サイズ: 20 バイト(x86)
dim st, 5    ; 4byte整数×5(構造体サイズ 20 / 4 切り上げ)
; Type : WORD (+0, 2byte)  wpoke st,0,値  /  値 = wpeek(st,0)
; Field : WORD (+2, 2byte)  wpoke st,2,値  /  値 = wpeek(st,2)
; Reserved : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; Id : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; NotifyData : _NotifyData_e__Union (+12, 8byte)  varptr(st)+12 を基点に操作(8byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; PRINTER_NOTIFY_INFO_DATA サイズ: 24 バイト(x64)
dim st, 6    ; 4byte整数×6(構造体サイズ 24 / 4 切り上げ)
; Type : WORD (+0, 2byte)  wpoke st,0,値  /  値 = wpeek(st,0)
; Field : WORD (+2, 2byte)  wpoke st,2,値  /  値 = wpeek(st,2)
; Reserved : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; Id : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; NotifyData : _NotifyData_e__Union (+16, 8byte)  varptr(st)+16 を基点に操作(8byte:入れ子/配列)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global PRINTER_NOTIFY_INFO_DATA
    #field short Type
    #field short Field
    #field int Reserved
    #field int Id
    #field byte NotifyData 8
#endstruct

stdim st, PRINTER_NOTIFY_INFO_DATA        ; NSTRUCT 変数を確保
st->Type = 100
mes "Type=" + st->Type
; ※union フィールドは byte 列で確保(NSTRUCT は union 非対応)。必要に応じ手動でアクセス。