Communications Toolbox Utilities interfaces. More...

#include <ConditionalMacros.h>
#include <MacTypes.h>
#include <MixedMode.h>
#include <Dialogs.h>
#include <AppleTalk.h>

Go to the source code of this file.

Data Structures
struct	NLTypeEntry

struct	NBPReply

Macros
#define	NewDialogHookUPP(userRoutine)

#define	NewNameFilterUPP(userRoutine)

#define	NewZoneFilterUPP(userRoutine)

#define	DisposeDialogHookUPP(userUPP) DisposeRoutineDescriptor(userUPP)

#define	DisposeNameFilterUPP(userUPP) DisposeRoutineDescriptor(userUPP)

#define	DisposeZoneFilterUPP(userUPP) DisposeRoutineDescriptor(userUPP)

#define	InvokeDialogHookUPP(item, theDialog, userUPP)

#define	InvokeNameFilterUPP(theEntity, userUPP) (short)CALL_ONE_PARAMETER_UPP((userUPP), uppNameFilterProcInfo, (theEntity))

#define	InvokeZoneFilterUPP(theZone, userUPP) (short)CALL_ONE_PARAMETER_UPP((userUPP), uppZoneFilterProcInfo, (theZone))

#define	NewDialogHookProc(userRoutine) NewDialogHookUPP(userRoutine)

#define	NewNameFilterProc(userRoutine) NewNameFilterUPP(userRoutine)

#define	NewZoneFilterProc(userRoutine) NewZoneFilterUPP(userRoutine)

#define	CallDialogHookProc(userRoutine, item, theDialog) InvokeDialogHookUPP(item, theDialog, userRoutine)

#define	CallNameFilterProc(userRoutine, theEntity) InvokeNameFilterUPP(theEntity, userRoutine)

#define	CallZoneFilterProc(userRoutine, theZone) InvokeZoneFilterUPP(theZone, userRoutine)

Typedefs
typedef OSErr	CTBUErr

typedef SInt16	ChooseReturnCode

typedef UInt16	NuLookupReturnCode

typedef UInt16	NameFilterReturnCode

typedef UInt16	ZoneFilterReturnCode

typedef struct NLTypeEntry	NLTypeEntry

typedef NLTypeEntry	NLType[4]

typedef struct NBPReply	NBPReply

typedef DialogRef	theDialog

Enumerations
enum	{ curCTBUVersion = 2 }

enum	{ ctbuGenericError = -1 , ctbuNoErr = 0 }

enum	{ chooseDisaster = -2 , chooseFailed = -1 , chooseAborted = 0 , chooseOKMinor = 1 , chooseOKMajor = 2 , chooseCancel = 3 }

enum	{ nlOk = 0 , nlCancel = 1 , nlEject = 2 }

enum	{ nameInclude = 1 , nameDisable = 2 , nameReject = 3 }

enum	{ zoneInclude = 1 , zoneDisable = 2 , zoneReject = 3 }

enum	{ hookOK = 1 , hookCancel = 2 , hookOutline = 3 , hookTitle = 4 , hookItemList = 5 , hookZoneTitle = 6 , hookZoneList = 7 , hookLine = 8 , hookVersion = 9 , hookReserved1 = 10 , hookReserved2 = 11 , hookReserved3 = 12 , hookReserved4 = 13 , hookNull = 100 , hookItemRefresh = 101 , hookZoneRefresh = 102 , hookEject = 103 , hookPreflight = 104 , hookPostflight = 105 , hookKeyBase = 1000 }

enum	{ uppDialogHookProcInfo = 0x000003A0 }

enum	{ uppNameFilterProcInfo = 0x000000E0 }

enum	{ uppZoneFilterProcInfo = 0x000000E0 }

Functions
typedef	CALLBACK_API (short, DialogHookProcPtr)(short item

typedef	CALLBACK_API (short, NameFilterProcPtr)(const EntityName *theEntity)

typedef	CALLBACK_API (short, ZoneFilterProcPtr)(ConstStr32Param theZone)

typedef	STACK_UPP_TYPE (DialogHookProcPtr) DialogHookUPP

typedef	STACK_UPP_TYPE (NameFilterProcPtr) NameFilterUPP

typedef	STACK_UPP_TYPE (ZoneFilterProcPtr) ZoneFilterUPP

DialogHookUPP	NewDialogHookUPP (DialogHookProcPtr userRoutine)

NameFilterUPP	NewNameFilterUPP (NameFilterProcPtr userRoutine)

ZoneFilterUPP	NewZoneFilterUPP (ZoneFilterProcPtr userRoutine)

void	DisposeDialogHookUPP (DialogHookUPP userUPP)

void	DisposeNameFilterUPP (NameFilterUPP userUPP)

void	DisposeZoneFilterUPP (ZoneFilterUPP userUPP)

short	InvokeDialogHookUPP (short item, DialogRef theDialog, DialogHookUPP userUPP)

short	InvokeNameFilterUPP (const EntityName *theEntity, NameFilterUPP userUPP)

short	InvokeZoneFilterUPP (ConstStr32Param theZone, ZoneFilterUPP userUPP)

CTBUErr	InitCTBUtilities (void)

short	CTBGetCTBVersion (void)

short	StandardNBP (Point where, ConstStr255Param prompt, short numTypes, NLType typeList, NameFilterUPP nameFilter, ZoneFilterUPP zoneFilter, DialogHookUPP hook, NBPReply *theReply)

short	CustomNBP (Point where, ConstStr255Param prompt, short numTypes, NLType typeList, NameFilterUPP nameFilter, ZoneFilterUPP zoneFilter, DialogHookUPP hook, long userData, short dialogID, ModalFilterUPP filter, NBPReply *theReply)

Detailed Description

Communications Toolbox Utilities interfaces.

Introduced In: System 7.5

Avaliable From: Universal Interfaces 3.4.1

Copyright: © 1988-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

◆ InvokeDialogHookUPP

#define InvokeDialogHookUPP	(	item,
		theDialog,
		userUPP
	)

Value:

(short)CALL_TWO_PARAMETER_UPP((userUPP), uppDialogHookProcInfo, (item), \

(theDialog))

GrafPort

Definition: Quickdraw.h:1648

◆ NewDialogHookProc

#define NewDialogHookProc ( userRoutine ) NewDialogHookUPP(userRoutine)

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

◆ NewDialogHookUPP

#define NewDialogHookUPP ( userRoutine )

Value:

(DialogHookUPP) NewRoutineDescriptor( \

(ProcPtr)(userRoutine), uppDialogHookProcInfo, GetCurrentArchitecture())

NewRoutineDescriptor

UniversalProcPtr NewRoutineDescriptor(ProcPtr theProc, ProcInfoType theProcInfo, ISAType theISA)

pascal 2_bytes Func(2_bytes, 4_bytes)

◆ NewNameFilterUPP

#define NewNameFilterUPP ( userRoutine )

Value:

(NameFilterUPP) NewRoutineDescriptor( \

(ProcPtr)(userRoutine), uppNameFilterProcInfo, GetCurrentArchitecture())

pascal 2_bytes Func(4_bytes)

◆ NewZoneFilterUPP

#define NewZoneFilterUPP ( userRoutine )

Value:

(ZoneFilterUPP) NewRoutineDescriptor( \

(ProcPtr)(userRoutine), uppZoneFilterProcInfo, GetCurrentArchitecture())

pascal 2_bytes Func(4_bytes)

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Enumerator
ctbuGenericError	Error codes/types

◆ anonymous enum

anonymous enum

Enumerator
hookOK	Values for hookProc items
hookNull	"virtual" hookProc items

Function Documentation

◆ CTBGetCTBVersion()

short CTBGetCTBVersion ( void )

CTBGetCTBVersion()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: not available

Mac OS X: not available

◆ CustomNBP()

short CustomNBP	(	Point	where,
		ConstStr255Param	prompt,
		short	numTypes,
		NLType	typeList,
		NameFilterUPP	nameFilter,
		ZoneFilterUPP	zoneFilter,
		DialogHookUPP	hook,
		long	userData,
		short	dialogID,
		ModalFilterUPP	filter,
		NBPReply *	theReply
	)

CustomNBP()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: not available

Mac OS X: not available

◆ DisposeDialogHookUPP()

void DisposeDialogHookUPP ( DialogHookUPP userUPP )

DisposeDialogHookUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: not available

Mac OS X: not available

◆ DisposeNameFilterUPP()

void DisposeNameFilterUPP ( NameFilterUPP userUPP )

DisposeNameFilterUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: not available

Mac OS X: not available

◆ DisposeZoneFilterUPP()

void DisposeZoneFilterUPP ( ZoneFilterUPP userUPP )

DisposeZoneFilterUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: not available

Mac OS X: not available

◆ InitCTBUtilities()

CTBUErr InitCTBUtilities ( void )

CALL_NOT_IN_CARBON CALL_NOT_IN_CARBON InitCTBUtilities()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: not available

Mac OS X: not available

◆ InvokeDialogHookUPP()

short InvokeDialogHookUPP	(	short	item,
		DialogRef	theDialog,
		DialogHookUPP	userUPP
	)

InvokeDialogHookUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: not available

Mac OS X: not available

◆ InvokeNameFilterUPP()

short InvokeNameFilterUPP	(	const EntityName *	theEntity,
		NameFilterUPP	userUPP
	)

InvokeNameFilterUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: not available

Mac OS X: not available

◆ InvokeZoneFilterUPP()

short InvokeZoneFilterUPP	(	ConstStr32Param	theZone,
		ZoneFilterUPP	userUPP
	)

InvokeZoneFilterUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: not available

Mac OS X: not available

◆ NewDialogHookUPP()

DialogHookUPP NewDialogHookUPP ( DialogHookProcPtr userRoutine )

NewDialogHookUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: not available

Mac OS X: not available

◆ NewNameFilterUPP()

NameFilterUPP NewNameFilterUPP ( NameFilterProcPtr userRoutine )

NewNameFilterUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: not available

Mac OS X: not available

◆ NewZoneFilterUPP()

ZoneFilterUPP NewZoneFilterUPP ( ZoneFilterProcPtr userRoutine )

NewZoneFilterUPP()

Non-Carbon CFM: available as macro/inline

Carbon Lib: not available

Mac OS X: not available

◆ StandardNBP()

short StandardNBP	(	Point	where,
		ConstStr255Param	prompt,
		short	numTypes,
		NLType	typeList,
		NameFilterUPP	nameFilter,
		ZoneFilterUPP	zoneFilter,
		DialogHookUPP	hook,
		NBPReply *	theReply
	)

StandardNBP()

Non-Carbon CFM: in InterfaceLib 7.1 and later

Carbon Lib: not available

Mac OS X: not available

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ InvokeDialogHookUPP

◆ NewDialogHookProc

◆ NewDialogHookUPP

◆ NewNameFilterUPP

◆ NewZoneFilterUPP

Enumeration Type Documentation

◆ anonymous enum

◆ anonymous enum

Function Documentation

◆ CTBGetCTBVersion()

◆ CustomNBP()

◆ DisposeDialogHookUPP()

◆ DisposeNameFilterUPP()

◆ DisposeZoneFilterUPP()

◆ InitCTBUtilities()

◆ InvokeDialogHookUPP()

◆ InvokeNameFilterUPP()

◆ InvokeZoneFilterUPP()

◆ NewDialogHookUPP()

◆ NewNameFilterUPP()

◆ NewZoneFilterUPP()

◆ StandardNBP()