Mac OS 9
Data Structures | Macros | Typedefs | Enumerations | Functions
DesktopPrinting.h File Reference
Hardware

Print driver declarations for classic PrintMonitor and Desktop PrintMonitor. More...

#include <MacTypes.h>
#include <Files.h>
#include <Printing.h>
#include <Quickdraw.h>
#include <MacErrors.h>

Go to the source code of this file.

Data Structures

struct  DTPSerialAddress
 
struct  DTPAppleTalkAddress
 
struct  DTPTCPIPAddress
 
struct  DTPSCSIAddress
 
struct  DTPUSBAddress
 
struct  DTPPrinterInfo
 
struct  TDTPPrGeneralData
 
struct  DTPInfoResource
 
struct  DTPInfo
 
struct  GestaltDTPInfoRec
 
struct  DTPAppleEventData
 
struct  TPrintMonitorPrintingData
 
struct  TDesktopPrintMonitorPrintingData
 
struct  SpoolFileHeader
 
struct  SpoolPage
 
struct  SpoolPREC126Record
 
struct  SpoolPageIndex
 
struct  DTPPrintJobInfo
 

Macros

#define NewDTPAsyncErrorNotificationUPP(userRoutine)
 
#define NewDTPEndNotificationUPP(userRoutine)
 
#define NewDTPInForegroundUPP(userRoutine)
 
#define NewDTPStatusMessageUPP(userRoutine)
 
#define DisposeDTPAsyncErrorNotificationUPP(userUPP)    DisposeRoutineDescriptor(userUPP)
 
#define DisposeDTPEndNotificationUPP(userUPP)   DisposeRoutineDescriptor(userUPP)
 
#define DisposeDTPInForegroundUPP(userUPP)   DisposeRoutineDescriptor(userUPP)
 
#define DisposeDTPStatusMessageUPP(userUPP)   DisposeRoutineDescriptor(userUPP)
 
#define InvokeDTPAsyncErrorNotificationUPP(errStr, userUPP)
 
#define InvokeDTPEndNotificationUPP(userUPP)    CALL_ZERO_PARAMETER_UPP((userUPP), uppDTPEndNotificationProcInfo)
 
#define InvokeDTPInForegroundUPP(userUPP)    (Boolean) CALL_ZERO_PARAMETER_UPP((userUPP), uppDTPInForegroundProcInfo)
 
#define InvokeDTPStatusMessageUPP(statusStr, userUPP)    CALL_ONE_PARAMETER_UPP((userUPP), uppDTPStatusMessageProcInfo, (statusStr))
 
#define NewDTPAsyncErrorNotificationProc(userRoutine)    NewDTPAsyncErrorNotificationUPP(userRoutine)
 
#define NewDTPEndNotificationProc(userRoutine)    NewDTPEndNotificationUPP(userRoutine)
 
#define NewDTPInForegroundProc(userRoutine)   NewDTPInForegroundUPP(userRoutine)
 
#define NewDTPStatusMessageProc(userRoutine)   NewDTPStatusMessageUPP(userRoutine)
 
#define CallDTPAsyncErrorNotificationProc(userRoutine, errStr)    InvokeDTPAsyncErrorNotificationUPP(errStr, userRoutine)
 
#define CallDTPEndNotificationProc(userRoutine)    InvokeDTPEndNotificationUPP(userRoutine)
 
#define CallDTPInForegroundProc(userRoutine)    InvokeDTPInForegroundUPP(userRoutine)
 
#define CallDTPStatusMessageProc(userRoutine, statusStr)    InvokeDTPStatusMessageUPP(statusStr, userRoutine)
 

Typedefs

typedef struct DTPSerialAddress DTPSerialAddress
 
typedef struct DTPAppleTalkAddress DTPAppleTalkAddress
 
typedef struct DTPTCPIPAddress DTPTCPIPAddress
 
typedef struct DTPSCSIAddress DTPSCSIAddress
 
typedef struct DTPUSBAddress DTPUSBAddress
 
typedef struct DTPPrinterInfo DTPPrinterInfo
 
typedef DTPPrinterInfo * DTPPrinterInfoPtr
 
typedef DTPPrinterInfoPtr * DTPPrinterInfoHandle
 
typedef struct TDTPPrGeneralData TDTPPrGeneralData
 
typedef struct DTPInfoResource DTPInfoResource
 
typedef struct DTPInfo DTPInfo
 
typedef struct GestaltDTPInfoRec GestaltDTPInfoRec
 
typedef GestaltDTPInfoRec * GestaltDTPInfoPtr
 
typedef GestaltDTPInfoPtr * GestaltDTPInfoHdle
 
typedef struct DTPAppleEventData DTPAppleEventData
 
typedef struct TPrintMonitorPrintingData TPrintMonitorPrintingData
 
typedef struct TDesktopPrintMonitorPrintingData TDesktopPrintMonitorPrintingData
 
typedef struct SpoolFileHeader SpoolFileHeader
 
typedef SpoolFileHeader * SpoolFileHeaderPtr
 
typedef SpoolFileHeaderPtr * SpoolFileHeaderHandle
 
typedef struct SpoolPage SpoolPage
 
typedef struct SpoolPREC126Record SpoolPREC126Record
 
typedef SpoolPREC126Record * SpoolPREC126Ptr
 
typedef SpoolPREC126Ptr * SpoolPREC126Handle
 
typedef struct SpoolPageIndex SpoolPageIndex
 
typedef SpoolPageIndex * SpoolPageIndexPtr
 
typedef SpoolPageIndexPtr * SpoolPageIndexHandle
 
typedef struct DTPPrintJobInfo DTPPrintJobInfo
 
typedef DTPPrintJobInfo * DTPPrintJobInfoPtr
 
typedef DTPPrintJobInfoPtr * DTPPrintJobInfoHandle
 

Enumerations

enum  {
  kDTPUnknownPrinterType = -1 , kDTPSerialPrinterType = 0 , kDTPAppleTalkPrinterType = 1 , kDTPTCPIPPrinterType = 2 ,
  kDTPSCSIPrinterType = 3 , kDTPUSBPrinterType = 4
}
 
enum  { kDTPUnknownPort = -1 , kDTPPrinterPort = 0 , kDTPModemPort = 1 }
 
enum  { kDTPGetPrinterInfo = 23 , kDTPIsSamePrinterInfo = 24 , kDTPSetDefaultPrinterInfo = 25 }
 
enum  { kDTPInfoResType = FOUR_CHAR_CODE('dtpi') , kDTPInfoResID = -8192 }
 
enum  {
  kDTPUnknownConnection = 0x00000000 , kDTPSerialConnection = 0x00000001 , kDTPSCSIConnection = 0x00000002 , kDTPAppleTalkConnection = 0x00000004 ,
  kDTPTCPIPConnection = 0x00000008 , kDTPUSBConnection = 0x00000010
}
 
enum  { kDTPBasicFeatures }
 
enum  { kDTPGestaltStructVersion2 , kDTPGestaltStructVersion3 = 0x03000000 }
 
enum  { kDTPSignature = FOUR_CHAR_CODE('dtpx') }
 
enum  { aeDTPSetDefaultEventType , aeDTPSyncEventType }
 
enum  { uppDTPAsyncErrorNotificationProcInfo = 0x000000C0 }
 
enum  { uppDTPEndNotificationProcInfo = 0x00000000 }
 
enum  { uppDTPInForegroundProcInfo = 0x00000010 }
 
enum  { uppDTPStatusMessageProcInfo = 0x000000C0 }
 
enum  { kPrintMonitorPrGeneral = -3 }
 
enum  { kDTPPrintJobUrgent = 0x00000001 , kDTPPrintJobAtTime = 0x00000002 , kDTPPrintJobNormal = 0x00000003 , kDTPPrintJobHolding = 0x00001003 }
 

Functions

typedef CALLBACK_API (void, DTPAsyncErrorNotificationProcPtr)(StringHandle errStr)
 
typedef CALLBACK_API (void, DTPEndNotificationProcPtr)(void)
 
typedef CALLBACK_API (Boolean, DTPInForegroundProcPtr)(void)
 
typedef CALLBACK_API (void, DTPStatusMessageProcPtr)(StringHandle statusStr)
 
typedef STACK_UPP_TYPE (DTPAsyncErrorNotificationProcPtr) DTPAsyncErrorNotificationUPP
 
typedef STACK_UPP_TYPE (DTPEndNotificationProcPtr) DTPEndNotificationUPP
 
typedef STACK_UPP_TYPE (DTPInForegroundProcPtr) DTPInForegroundUPP
 
typedef STACK_UPP_TYPE (DTPStatusMessageProcPtr) DTPStatusMessageUPP
 
DTPAsyncErrorNotificationUPP NewDTPAsyncErrorNotificationUPP (DTPAsyncErrorNotificationProcPtr userRoutine)
 
DTPEndNotificationUPP NewDTPEndNotificationUPP (DTPEndNotificationProcPtr userRoutine)
 
DTPInForegroundUPP NewDTPInForegroundUPP (DTPInForegroundProcPtr userRoutine)
 
DTPStatusMessageUPP NewDTPStatusMessageUPP (DTPStatusMessageProcPtr userRoutine)
 
void DisposeDTPAsyncErrorNotificationUPP (DTPAsyncErrorNotificationUPP userUPP)
 
void DisposeDTPEndNotificationUPP (DTPEndNotificationUPP userUPP)
 
void DisposeDTPInForegroundUPP (DTPInForegroundUPP userUPP)
 
void DisposeDTPStatusMessageUPP (DTPStatusMessageUPP userUPP)
 
void InvokeDTPAsyncErrorNotificationUPP (StringHandle errStr, DTPAsyncErrorNotificationUPP userUPP)
 
void InvokeDTPEndNotificationUPP (DTPEndNotificationUPP userUPP)
 
Boolean InvokeDTPInForegroundUPP (DTPInForegroundUPP userUPP)
 
void InvokeDTPStatusMessageUPP (StringHandle statusStr, DTPStatusMessageUPP userUPP)
 

Detailed Description

Print driver declarations for classic PrintMonitor and Desktop PrintMonitor.

Introduced In: Mac OS 8.5
Avaliable From: Universal Interfaces 3.4.1
Copyright: © 1998-2001 by Apple Computer, Inc., all rights reserved

For bug reports, consult the following page on the World Wide Web: 

http://developer.apple.com/bugreporter/

Macro Definition Documentation

◆ InvokeDTPAsyncErrorNotificationUPP

#define InvokeDTPAsyncErrorNotificationUPP (   errStr,
  userUPP 
)
Value:
CALL_ONE_PARAMETER_UPP((userUPP), uppDTPAsyncErrorNotificationProcInfo, \
(errStr))

◆ NewDTPAsyncErrorNotificationProc

#define NewDTPAsyncErrorNotificationProc (   userRoutine)     NewDTPAsyncErrorNotificationUPP(userRoutine)

CALL_NOT_IN_CARBON support for pre-Carbon UPP routines: New...Proc and Call...Proc

◆ NewDTPAsyncErrorNotificationUPP

#define NewDTPAsyncErrorNotificationUPP (   userRoutine)
Value:
(DTPAsyncErrorNotificationUPP) NewRoutineDescriptor( \
(ProcPtr)(userRoutine), uppDTPAsyncErrorNotificationProcInfo, \
GetCurrentArchitecture())
NewRoutineDescriptor
UniversalProcPtr NewRoutineDescriptor(ProcPtr theProc, ProcInfoType theProcInfo, ISAType theISA)

pascal no_return_value Func(4_bytes)

◆ NewDTPEndNotificationUPP

#define NewDTPEndNotificationUPP (   userRoutine)
Value:
(DTPEndNotificationUPP) NewRoutineDescriptor((ProcPtr)(userRoutine), \
uppDTPEndNotificationProcInfo, \
GetCurrentArchitecture())

pascal no_return_value Func()

◆ NewDTPInForegroundUPP

#define NewDTPInForegroundUPP (   userRoutine)
Value:
(DTPInForegroundUPP) \
NewRoutineDescriptor((ProcPtr)(userRoutine), uppDTPInForegroundProcInfo, \
GetCurrentArchitecture())

pascal 1_byte Func()

◆ NewDTPStatusMessageUPP

#define NewDTPStatusMessageUPP (   userRoutine)
Value:
(DTPStatusMessageUPP) NewRoutineDescriptor((ProcPtr)(userRoutine), \
uppDTPStatusMessageProcInfo, \
GetCurrentArchitecture())

pascal no_return_value Func(4_bytes)

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

PrGeneral opcodes for desktop printng DTP printer types (address types)

Enumerator
kDTPSerialPrinterType 

unknown address type

kDTPAppleTalkPrinterType 

serial printer

kDTPTCPIPPrinterType 

AppleTalk printer

kDTPSCSIPrinterType 

TCP/IP printer

kDTPUSBPrinterType 

SCSI printer

◆ anonymous enum

anonymous enum

serial ports

Enumerator
kDTPPrinterPort 

for drivers that support serial connection by the Comm Toolbox other than modem and printer port

kDTPModemPort 

printer port

◆ anonymous enum

anonymous enum

PrGeneral opcodes

◆ anonymous enum

anonymous enum

desktop printer info resource

◆ anonymous enum

anonymous enum

connection types supported

Enumerator
kDTPSerialConnection 

unknown connection type

kDTPSCSIConnection 

serial connection

kDTPAppleTalkConnection 

SCSI connection

kDTPTCPIPConnection 

AppleTalk connection

kDTPUSBConnection 

TCP/IP connection

◆ anonymous enum

anonymous enum

dtp extra features supported

◆ anonymous enum

anonymous enum
Enumerator
kDTPGestaltStructVersion2 

GestaltDTPInfoRec.version

kDTPGestaltStructVersion3 

version 2.0f0 (for Mac OS 8.0, 8.1 and 7.x)

◆ anonymous enum

anonymous enum

AppleEvents

◆ anonymous enum

anonymous enum
Enumerator
aeDTPSyncEventType 

for setting a desktop printer to be the default

◆ anonymous enum

anonymous enum

CALL_NOT_IN_CARBON PrGeneral call that PrintMonitor/Desktop PrintMonitor use to set up the notification procs

◆ anonymous enum

anonymous enum

jobi 1 (DTP print job information resource) print priorities

Function Documentation

◆ CALLBACK_API() [1/4]

typedef CALLBACK_API ( Boolean  ,
DTPInForegroundProcPtr   
)

DTPInForegroundUPP

◆ CALLBACK_API() [2/4]

typedef CALLBACK_API ( void  ,
DTPAsyncErrorNotificationProcPtr   
)

Notification during de-spooling DTPAsyncErrorNotificationUPP

◆ CALLBACK_API() [3/4]

typedef CALLBACK_API ( void  ,
DTPEndNotificationProcPtr   
)

DTPEndNotificationUPP

◆ CALLBACK_API() [4/4]

typedef CALLBACK_API ( void  ,
DTPStatusMessageProcPtr   
)

DTPStatusMessageUPP

◆ DisposeDTPAsyncErrorNotificationUPP()

void DisposeDTPAsyncErrorNotificationUPP ( DTPAsyncErrorNotificationUPP  userUPP)

DisposeDTPAsyncErrorNotificationUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: not available
Mac OS X: not available

◆ DisposeDTPEndNotificationUPP()

void DisposeDTPEndNotificationUPP ( DTPEndNotificationUPP  userUPP)

DisposeDTPEndNotificationUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: not available
Mac OS X: not available

◆ DisposeDTPInForegroundUPP()

void DisposeDTPInForegroundUPP ( DTPInForegroundUPP  userUPP)

DisposeDTPInForegroundUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: not available
Mac OS X: not available

◆ DisposeDTPStatusMessageUPP()

void DisposeDTPStatusMessageUPP ( DTPStatusMessageUPP  userUPP)

DisposeDTPStatusMessageUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: not available
Mac OS X: not available

◆ InvokeDTPAsyncErrorNotificationUPP()

void InvokeDTPAsyncErrorNotificationUPP ( StringHandle  errStr,
DTPAsyncErrorNotificationUPP  userUPP 
)

InvokeDTPAsyncErrorNotificationUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: not available
Mac OS X: not available

◆ InvokeDTPEndNotificationUPP()

void InvokeDTPEndNotificationUPP ( DTPEndNotificationUPP  userUPP)

InvokeDTPEndNotificationUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: not available
Mac OS X: not available

◆ InvokeDTPInForegroundUPP()

Boolean InvokeDTPInForegroundUPP ( DTPInForegroundUPP  userUPP)

InvokeDTPInForegroundUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: not available
Mac OS X: not available

◆ InvokeDTPStatusMessageUPP()

void InvokeDTPStatusMessageUPP ( StringHandle  statusStr,
DTPStatusMessageUPP  userUPP 
)

InvokeDTPStatusMessageUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: not available
Mac OS X: not available

◆ NewDTPAsyncErrorNotificationUPP()

DTPAsyncErrorNotificationUPP NewDTPAsyncErrorNotificationUPP ( DTPAsyncErrorNotificationProcPtr  userRoutine)

NewDTPAsyncErrorNotificationUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: not available
Mac OS X: not available

◆ NewDTPEndNotificationUPP()

DTPEndNotificationUPP NewDTPEndNotificationUPP ( DTPEndNotificationProcPtr  userRoutine)

NewDTPEndNotificationUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: not available
Mac OS X: not available

◆ NewDTPInForegroundUPP()

DTPInForegroundUPP NewDTPInForegroundUPP ( DTPInForegroundProcPtr  userRoutine)

NewDTPInForegroundUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: not available
Mac OS X: not available

◆ NewDTPStatusMessageUPP()

DTPStatusMessageUPP NewDTPStatusMessageUPP ( DTPStatusMessageProcPtr  userRoutine)

NewDTPStatusMessageUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: not available
Mac OS X: not available