_LOCALMON_PORT Struct Reference

#include <precomp.h>

Collaboration diagram for _LOCALMON_PORT:

Public Types
enum	{ PortType_Other = 0 , PortType_FILE , PortType_PhysicalCOM , PortType_PhysicalLPT }

Public Attributes
LIST_ENTRY	Entry
PWSTR	pwszPortName
PLOCALMON_HANDLE	pLocalmon
DWORD	Sig
enum _LOCALMON_PORT:: { ... }	PortType
BOOL	bStartedDoc
DWORD	dwJobID
HANDLE	hFile
HANDLE	hPrinter
PWSTR	pwszMapping

Detailed Description

Describes the port handle returned by LocalmonOpenPort. Manages a legacy port (COM/LPT) or virtual FILE: port for printing as well as its associated printer and job.

Definition at line 52 of file precomp.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
PortType_Other
PortType_FILE	Any port that doesn't belong into the other categories (default).
PortType_PhysicalCOM	A port created when a document is printed on FILE: and the user entered a file name.
PortType_PhysicalLPT	A physical serial port (COM) A physical parallel port (LPT)

Definition at line 58 of file precomp.h.

         {
        PortType_Other = 0,         
        PortType_FILE,              
        PortType_PhysicalCOM,       
        PortType_PhysicalLPT        
    }

Member Data Documentation

bStartedDoc

BOOL _LOCALMON_PORT::bStartedDoc

Definition at line 65 of file precomp.h.

Referenced by LocalmonEndDocPort(), and LocalmonStartDocPort().

dwJobID

DWORD _LOCALMON_PORT::dwJobID

Whether a document has been started with StartDocPort.

Definition at line 66 of file precomp.h.

Referenced by LocalmonEndDocPort(), and LocalmonStartDocPort().

Entry

LIST_ENTRY _LOCALMON_PORT::Entry

Definition at line 54 of file precomp.h.

Referenced by _HandleAddPort(), _HandleDeletePort(), InitializePrintMonitor2(), LocalmonAddPort(), LocalmonAddPortEx(), LocalmonClosePort(), LocalmonDeletePort(), and LocalmonOpenPort().

hFile

HANDLE _LOCALMON_PORT::hFile

ID of the printing job we are processing (for later reporting progress using SetJobW).

Definition at line 67 of file precomp.h.

Referenced by _ClosePortHandles(), _CreateNonspooledPort(), _HandleAddPort(), _SetTransmissionRetryTimeout(), InitializePrintMonitor2(), LocalmonAddPort(), LocalmonAddPortEx(), LocalmonGetPrinterDataFromPort(), LocalmonOpenPort(), LocalmonReadPort(), LocalmonSetPortTimeOuts(), LocalmonStartDocPort(), and LocalmonWritePort().

hPrinter

HANDLE _LOCALMON_PORT::hPrinter

Handle to the opened port or INVALID_HANDLE_VALUE if it isn't currently opened.

Definition at line 68 of file precomp.h.

Referenced by LocalmonClosePort(), LocalmonEndDocPort(), and LocalmonStartDocPort().

pLocalmon

PLOCALMON_HANDLE _LOCALMON_PORT::pLocalmon

The name of this port including the trailing colon. Empty for virtual file ports.

Definition at line 56 of file precomp.h.

Referenced by _HandleAddPort(), _HandleDeletePort(), InitializePrintMonitor2(), LocalmonAddPort(), LocalmonAddPortEx(), LocalmonClosePort(), LocalmonDeletePort(), and LocalmonOpenPort().

enum { ... } _LOCALMON_PORT::PortType

Referenced by LocalmonClosePort(), LocalmonEndDocPort(), LocalmonGetPrinterDataFromPort(), LocalmonOpenPort(), LocalmonReadPort(), LocalmonSetPortTimeOuts(), LocalmonStartDocPort(), and LocalmonWritePort().

pwszMapping

PWSTR _LOCALMON_PORT::pwszMapping

Handle to the printer for the job on this port (for using SetJobW).

Definition at line 69 of file precomp.h.

Referenced by _ClosePortHandles(), and _CreateNonspooledPort().

pwszPortName

PWSTR _LOCALMON_PORT::pwszPortName

Definition at line 55 of file precomp.h.

Referenced by _ClosePortHandles(), _CreateNonspooledPort(), _FindPort(), _HandleAddPort(), _HandleDeletePort(), _LocalmonGetPortLevel1(), _LocalmonGetPortLevel2(), InitializePrintMonitor2(), LocalmonAddPort(), LocalmonAddPortEx(), and LocalmonStartDocPort().

Sig

DWORD _LOCALMON_PORT::Sig

Pointer to the parent LOCALMON_HANDLE structure.

Definition at line 57 of file precomp.h.

Referenced by InitializePrintMonitor2(), LocalmonAddPort(), and LocalmonAddPortEx().

---

The documentation for this struct was generated from the following file:

• win32ss/printing/monitors/localmon/precomp.h