Mac OS 9
StandardFile.h File Reference

Standard File package Interfaces. More...

#include <MacTypes.h>
#include <Dialogs.h>
#include <Files.h>

Go to the source code of this file.

Data Structures

struct  SFReply
 
struct  StandardFileReply
 

Macros

#define NewDlgHookUPP(userRoutine)
 
#define NewFileFilterUPP(userRoutine)
 
#define NewDlgHookYDUPP(userRoutine)
 
#define NewFileFilterYDUPP(userRoutine)
 
#define NewActivateYDUPP(userRoutine)
 
#define DisposeDlgHookUPP(userUPP)   DisposeRoutineDescriptor(userUPP)
 
#define DisposeFileFilterUPP(userUPP)   DisposeRoutineDescriptor(userUPP)
 
#define DisposeDlgHookYDUPP(userUPP)   DisposeRoutineDescriptor(userUPP)
 
#define DisposeFileFilterYDUPP(userUPP)   DisposeRoutineDescriptor(userUPP)
 
#define DisposeActivateYDUPP(userUPP)   DisposeRoutineDescriptor(userUPP)
 
#define InvokeDlgHookUPP(item, theDialog, userUPP)
 
#define InvokeFileFilterUPP(pb, userUPP)    (Boolean) CALL_ONE_PARAMETER_UPP((userUPP), uppFileFilterProcInfo, (pb))
 
#define InvokeDlgHookYDUPP(item, theDialog, yourDataPtr, userUPP)
 
#define InvokeFileFilterYDUPP(pb, yourDataPtr, userUPP)
 
#define InvokeActivateYDUPP(theDialog, itemNo, activating, yourDataPtr, userUPP)
 
#define NewDlgHookProc(userRoutine)   NewDlgHookUPP(userRoutine)
 
#define NewFileFilterProc(userRoutine)   NewFileFilterUPP(userRoutine)
 
#define NewDlgHookYDProc(userRoutine)   NewDlgHookYDUPP(userRoutine)
 
#define NewFileFilterYDProc(userRoutine)   NewFileFilterYDUPP(userRoutine)
 
#define NewActivateYDProc(userRoutine)   NewActivateYDUPP(userRoutine)
 
#define CallDlgHookProc(userRoutine, item, theDialog)    InvokeDlgHookUPP(item, theDialog, userRoutine)
 
#define CallFileFilterProc(userRoutine, pb)   InvokeFileFilterUPP(pb, userRoutine)
 
#define CallDlgHookYDProc(userRoutine, item, theDialog, yourDataPtr)    InvokeDlgHookYDUPP(item, theDialog, yourDataPtr, userRoutine)
 
#define CallFileFilterYDProc(userRoutine, pb, yourDataPtr)    InvokeFileFilterYDUPP(pb, yourDataPtr, userRoutine)
 
#define CallActivateYDProc(userRoutine, theDialog, itemNo, activating, yourDataPtr)    InvokeActivateYDUPP(theDialog, itemNo, activating, yourDataPtr, userRoutine)
 

Typedefs

typedef struct SFReply SFReply
 
typedef struct StandardFileReply StandardFileReply
 
typedef const short * ActivationOrderListPtr
 
typedef DialogRef theDialog
 
typedef DialogRef void * yourDataPtr
 
typedef short itemNo
 
typedef short Boolean activating
 
typedef OSType SFTypeList[4]
 
typedef const OSType * ConstSFTypeListPtr
 

Enumerations

enum  { putDlgID = -3999 , getDlgID = -4000 }
 
enum  {
  putSave = 1 , putCancel = 2 , putEject = 5 , putDrive = 6 ,
  putName = 7 , getOpen = 1 , getCancel = 3 , getEject = 5 ,
  getDrive = 6 , getNmList = 7 , getScroll = 8
}
 
enum  { sfPutDialogID = -6043 , sfGetDialogID = -6042 }
 
enum  {
  sfItemOpenButton = 1 , sfItemCancelButton = 2 , sfItemBalloonHelp = 3 , sfItemVolumeUser = 4 ,
  sfItemEjectButton = 5 , sfItemDesktopButton = 6 , sfItemFileListUser = 7 , sfItemPopUpMenuUser = 8 ,
  sfItemDividerLinePict = 9 , sfItemFileNameTextEdit = 10 , sfItemPromptStaticText = 11 , sfItemNewFolderUser = 12
}
 
enum  {
  sfHookFirstCall = -1 , sfHookCharOffset = 0x1000 , sfHookNullEvent = 100 , sfHookRebuildList = 101 ,
  sfHookFolderPopUp = 102 , sfHookOpenFolder = 103 , sfHookLastCall = -2 , sfHookOpenAlias = 104 ,
  sfHookGoToDesktop = 105 , sfHookGoToAliasTarget = 106 , sfHookGoToParent = 107 , sfHookGoToNextDrive = 108 ,
  sfHookGoToPrevDrive = 109 , sfHookChangeSelection = 110 , sfHookSetActiveOffset = 200
}
 
enum  {
  sfMainDialogRefCon = FOUR_CHAR_CODE('stdf') , sfNewFolderDialogRefCon = FOUR_CHAR_CODE('nfdr') , sfReplaceDialogRefCon = FOUR_CHAR_CODE('rplc') , sfStatWarnDialogRefCon = FOUR_CHAR_CODE('stat') ,
  sfLockWarnDialogRefCon = FOUR_CHAR_CODE('lock') , sfErrorDialogRefCon = FOUR_CHAR_CODE('err ')
}
 
enum  { uppDlgHookProcInfo = 0x000003A0 }
 
enum  { uppFileFilterProcInfo = 0x000000D0 }
 
enum  { uppDlgHookYDProcInfo = 0x00000FA0 }
 
enum  { uppFileFilterYDProcInfo = 0x000003D0 }
 
enum  { uppActivateYDProcInfo = 0x000036C0 }
 

Functions

typedef CALLBACK_API (short, DlgHookProcPtr)(short item
 
typedef CALLBACK_API (Boolean, FileFilterProcPtr)(CInfoPBPtr pb)
 
typedef CALLBACK_API (short, DlgHookYDProcPtr)(short item
 
typedef CALLBACK_API (Boolean, FileFilterYDProcPtr)(CInfoPBPtr pb
 
typedef CALLBACK_API (void, ActivateYDProcPtr)(DialogRef theDialog
 
typedef STACK_UPP_TYPE (DlgHookProcPtr) DlgHookUPP
 
typedef STACK_UPP_TYPE (FileFilterProcPtr) FileFilterUPP
 
typedef STACK_UPP_TYPE (DlgHookYDProcPtr) DlgHookYDUPP
 
typedef STACK_UPP_TYPE (FileFilterYDProcPtr) FileFilterYDUPP
 
typedef STACK_UPP_TYPE (ActivateYDProcPtr) ActivateYDUPP
 
DlgHookUPP NewDlgHookUPP (DlgHookProcPtr userRoutine)
 
FileFilterUPP NewFileFilterUPP (FileFilterProcPtr userRoutine)
 
DlgHookYDUPP NewDlgHookYDUPP (DlgHookYDProcPtr userRoutine)
 
FileFilterYDUPP NewFileFilterYDUPP (FileFilterYDProcPtr userRoutine)
 
ActivateYDUPP NewActivateYDUPP (ActivateYDProcPtr userRoutine)
 
void DisposeDlgHookUPP (DlgHookUPP userUPP)
 
void DisposeFileFilterUPP (FileFilterUPP userUPP)
 
void DisposeDlgHookYDUPP (DlgHookYDUPP userUPP)
 
void DisposeFileFilterYDUPP (FileFilterYDUPP userUPP)
 
void DisposeActivateYDUPP (ActivateYDUPP userUPP)
 
short InvokeDlgHookUPP (short item, DialogRef theDialog, DlgHookUPP userUPP)
 
Boolean InvokeFileFilterUPP (CInfoPBPtr pb, FileFilterUPP userUPP)
 
short InvokeDlgHookYDUPP (short item, DialogRef theDialog, void *yourDataPtr, DlgHookYDUPP userUPP)
 
Boolean InvokeFileFilterYDUPP (CInfoPBPtr pb, void *yourDataPtr, FileFilterYDUPP userUPP)
 
void InvokeActivateYDUPP (DialogRef theDialog, short itemNo, Boolean activating, void *yourDataPtr, ActivateYDUPP userUPP)
 
void SFPutFile (Point where, ConstStr255Param prompt, ConstStr255Param origName, DlgHookUPP dlgHook, SFReply *reply)
 
void SFGetFile (Point where, ConstStr255Param prompt, FileFilterUPP fileFilter, short numTypes, ConstSFTypeListPtr typeList, DlgHookUPP dlgHook, SFReply *reply)
 
void SFPPutFile (Point where, ConstStr255Param prompt, ConstStr255Param origName, DlgHookUPP dlgHook, SFReply *reply, short dlgID, ModalFilterUPP filterProc)
 
void SFPGetFile (Point where, ConstStr255Param prompt, FileFilterUPP fileFilter, short numTypes, ConstSFTypeListPtr typeList, DlgHookUPP dlgHook, SFReply *reply, short dlgID, ModalFilterUPP filterProc)
 
void StandardPutFile (ConstStr255Param prompt, ConstStr255Param defaultName, StandardFileReply *reply)
 
void StandardGetFile (FileFilterUPP fileFilter, short numTypes, ConstSFTypeListPtr typeList, StandardFileReply *reply)
 
void CustomPutFile (ConstStr255Param prompt, ConstStr255Param defaultName, StandardFileReply *reply, short dlgID, Point where, DlgHookYDUPP dlgHook, ModalFilterYDUPP filterProc, ActivationOrderListPtr activeList, ActivateYDUPP activate, void *yourDataPtr)
 
void CustomGetFile (FileFilterYDUPP fileFilter, short numTypes, ConstSFTypeListPtr typeList, StandardFileReply *reply, short dlgID, Point where, DlgHookYDUPP dlgHook, ModalFilterYDUPP filterProc, ActivationOrderListPtr activeList, ActivateYDUPP activate, void *yourDataPtr)
 
OSErr StandardOpenDialog (StandardFileReply *reply)
 
void sfpputfile (Point *where, const char *prompt, const char *origName, DlgHookUPP dlgHook, SFReply *reply, short dlgID, ModalFilterUPP filterProc)
 
void sfgetfile (Point *where, const char *prompt, FileFilterUPP fileFilter, short numTypes, ConstSFTypeListPtr typeList, DlgHookUPP dlgHook, SFReply *reply)
 
void sfpgetfile (Point *where, const char *prompt, FileFilterUPP fileFilter, short numTypes, ConstSFTypeListPtr typeList, DlgHookUPP dlgHook, SFReply *reply, short dlgID, ModalFilterUPP filterProc)
 
void sfputfile (Point *where, const char *prompt, const char *origName, DlgHookUPP dlgHook, SFReply *reply)
 

Detailed Description

Standard File package Interfaces.

Introduced In: System 7.5
Avaliable From: Universal Interfaces 3.4.1
Copyright: � 1990-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

◆ InvokeActivateYDUPP

#define InvokeActivateYDUPP (   theDialog,
  itemNo,
  activating,
  yourDataPtr,
  userUPP 
)
Value:
CALL_FOUR_PARAMETER_UPP((userUPP), uppActivateYDProcInfo, (theDialog), \
(itemNo), (activating), (yourDataPtr))
Definition: Quickdraw.h:1648

◆ InvokeDlgHookUPP

#define InvokeDlgHookUPP (   item,
  theDialog,
  userUPP 
)
Value:
(short)CALL_TWO_PARAMETER_UPP((userUPP), uppDlgHookProcInfo, (item), \

◆ InvokeDlgHookYDUPP

#define InvokeDlgHookYDUPP (   item,
  theDialog,
  yourDataPtr,
  userUPP 
)
Value:
(short)CALL_THREE_PARAMETER_UPP((userUPP), uppDlgHookYDProcInfo, (item), \
(theDialog), (yourDataPtr))

◆ InvokeFileFilterYDUPP

#define InvokeFileFilterYDUPP (   pb,
  yourDataPtr,
  userUPP 
)
Value:
(Boolean) CALL_TWO_PARAMETER_UPP((userUPP), uppFileFilterYDProcInfo, (pb), \
(yourDataPtr))
unsigned char Boolean
Definition: MacTypes.h:318
Definition: ATA.h:616

◆ NewActivateYDUPP

#define NewActivateYDUPP (   userRoutine)
Value:
(ActivateYDUPP) NewRoutineDescriptor( \
(ProcPtr)(userRoutine), uppActivateYDProcInfo, GetCurrentArchitecture())
UniversalProcPtr NewRoutineDescriptor(ProcPtr theProc, ProcInfoType theProcInfo, ISAType theISA)

◆ NewDlgHookUPP

#define NewDlgHookUPP (   userRoutine)
Value:
(DlgHookUPP) NewRoutineDescriptor( \
(ProcPtr)(userRoutine), uppDlgHookProcInfo, GetCurrentArchitecture())

◆ NewDlgHookYDUPP

#define NewDlgHookYDUPP (   userRoutine)
Value:
(DlgHookYDUPP) NewRoutineDescriptor( \
(ProcPtr)(userRoutine), uppDlgHookYDProcInfo, GetCurrentArchitecture())

◆ NewFileFilterUPP

#define NewFileFilterUPP (   userRoutine)
Value:
(FileFilterUPP) NewRoutineDescriptor( \
(ProcPtr)(userRoutine), uppFileFilterProcInfo, GetCurrentArchitecture())

◆ NewFileFilterYDUPP

#define NewFileFilterYDUPP (   userRoutine)
Value:
(FileFilterYDUPP) \
NewRoutineDescriptor((ProcPtr)(userRoutine), uppFileFilterYDProcInfo, \
GetCurrentArchitecture())

Typedef Documentation

◆ ConstSFTypeListPtr

typedef const OSType* ConstSFTypeListPtr

The GetFile "typeList" parameter type has changed from "SFTypeList" to "ConstSFTypeListPtr". For C, this will add "const" and make it an in-only parameter. For Pascal, this will require client code to use the @ operator, but make it easier to specify long lists.

ConstSFTypeListPtr is a pointer to an array of OSTypes.

Function Documentation

◆ CustomGetFile()

void CustomGetFile ( FileFilterYDUPP  fileFilter,
short  numTypes,
ConstSFTypeListPtr  typeList,
StandardFileReply reply,
short  dlgID,
Point  where,
DlgHookYDUPP  dlgHook,
ModalFilterYDUPP  filterProc,
ActivationOrderListPtr  activeList,
ActivateYDUPP  activate,
void *  yourDataPtr 
)

CustomGetFile()

Availability:

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ CustomPutFile()

void CustomPutFile ( ConstStr255Param  prompt,
ConstStr255Param  defaultName,
StandardFileReply reply,
short  dlgID,
Point  where,
DlgHookYDUPP  dlgHook,
ModalFilterYDUPP  filterProc,
ActivationOrderListPtr  activeList,
ActivateYDUPP  activate,
void *  yourDataPtr 
)

CustomPutFile()

Availability:

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ DisposeActivateYDUPP()

void DisposeActivateYDUPP ( ActivateYDUPP  userUPP)

DisposeActivateYDUPP()

Availability:

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

◆ DisposeDlgHookUPP()

void DisposeDlgHookUPP ( DlgHookUPP  userUPP)

DisposeDlgHookUPP()

Availability:

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

◆ DisposeDlgHookYDUPP()

void DisposeDlgHookYDUPP ( DlgHookYDUPP  userUPP)

DisposeDlgHookYDUPP()

Availability:

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

◆ DisposeFileFilterUPP()

void DisposeFileFilterUPP ( FileFilterUPP  userUPP)

DisposeFileFilterUPP()

Availability:

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

◆ DisposeFileFilterYDUPP()

void DisposeFileFilterYDUPP ( FileFilterYDUPP  userUPP)

DisposeFileFilterYDUPP()

Availability:

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

◆ InvokeActivateYDUPP()

void InvokeActivateYDUPP ( DialogRef  theDialog,
short  itemNo,
Boolean  activating,
void *  yourDataPtr,
ActivateYDUPP  userUPP 
)

InvokeActivateYDUPP()

Availability:

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

◆ InvokeDlgHookUPP()

short InvokeDlgHookUPP ( short  item,
DialogRef  theDialog,
DlgHookUPP  userUPP 
)

InvokeDlgHookUPP()

Availability:

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

◆ InvokeDlgHookYDUPP()

short InvokeDlgHookYDUPP ( short  item,
DialogRef  theDialog,
void *  yourDataPtr,
DlgHookYDUPP  userUPP 
)

InvokeDlgHookYDUPP()

Availability:

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

◆ InvokeFileFilterUPP()

Boolean InvokeFileFilterUPP ( CInfoPBPtr  pb,
FileFilterUPP  userUPP 
)

InvokeFileFilterUPP()

Availability:

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

◆ InvokeFileFilterYDUPP()

Boolean InvokeFileFilterYDUPP ( CInfoPBPtr  pb,
void *  yourDataPtr,
FileFilterYDUPP  userUPP 
)

InvokeFileFilterYDUPP()

Availability:

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

◆ NewActivateYDUPP()

ActivateYDUPP NewActivateYDUPP ( ActivateYDProcPtr  userRoutine)

NewActivateYDUPP()

Availability:

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

◆ NewDlgHookUPP()

DlgHookUPP NewDlgHookUPP ( DlgHookProcPtr  userRoutine)

NewDlgHookUPP()

Availability:

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

◆ NewDlgHookYDUPP()

DlgHookYDUPP NewDlgHookYDUPP ( DlgHookYDProcPtr  userRoutine)

NewDlgHookYDUPP()

Availability:

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

◆ NewFileFilterUPP()

FileFilterUPP NewFileFilterUPP ( FileFilterProcPtr  userRoutine)

NewFileFilterUPP()

Availability:

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

◆ NewFileFilterYDUPP()

FileFilterYDUPP NewFileFilterYDUPP ( FileFilterYDProcPtr  userRoutine)

NewFileFilterYDUPP()

Availability:

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

◆ sfgetfile()

void sfgetfile ( Point where,
const char *  prompt,
FileFilterUPP  fileFilter,
short  numTypes,
ConstSFTypeListPtr  typeList,
DlgHookUPP  dlgHook,
SFReply reply 
)

sfgetfile()

Availability:

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ SFGetFile()

void SFGetFile ( Point  where,
ConstStr255Param  prompt,
FileFilterUPP  fileFilter,
short  numTypes,
ConstSFTypeListPtr  typeList,
DlgHookUPP  dlgHook,
SFReply reply 
)

SFGetFile()

Availability:

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ sfpgetfile()

void sfpgetfile ( Point where,
const char *  prompt,
FileFilterUPP  fileFilter,
short  numTypes,
ConstSFTypeListPtr  typeList,
DlgHookUPP  dlgHook,
SFReply reply,
short  dlgID,
ModalFilterUPP  filterProc 
)

sfpgetfile()

Availability:

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ SFPGetFile()

void SFPGetFile ( Point  where,
ConstStr255Param  prompt,
FileFilterUPP  fileFilter,
short  numTypes,
ConstSFTypeListPtr  typeList,
DlgHookUPP  dlgHook,
SFReply reply,
short  dlgID,
ModalFilterUPP  filterProc 
)

SFPGetFile()

Availability:

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ sfpputfile()

void sfpputfile ( Point where,
const char *  prompt,
const char *  origName,
DlgHookUPP  dlgHook,
SFReply reply,
short  dlgID,
ModalFilterUPP  filterProc 
)

sfpputfile()

Availability:

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ SFPPutFile()

void SFPPutFile ( Point  where,
ConstStr255Param  prompt,
ConstStr255Param  origName,
DlgHookUPP  dlgHook,
SFReply reply,
short  dlgID,
ModalFilterUPP  filterProc 
)

SFPPutFile()

Availability:

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ sfputfile()

void sfputfile ( Point where,
const char *  prompt,
const char *  origName,
DlgHookUPP  dlgHook,
SFReply reply 
)

sfputfile()

Availability:

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ SFPutFile()

void SFPutFile ( Point  where,
ConstStr255Param  prompt,
ConstStr255Param  origName,
DlgHookUPP  dlgHook,
SFReply reply 
)

SFPutFile()

Availability:

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ StandardGetFile()

void StandardGetFile ( FileFilterUPP  fileFilter,
short  numTypes,
ConstSFTypeListPtr  typeList,
StandardFileReply reply 
)

StandardGetFile()

Availability:

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available

◆ StandardOpenDialog()

OSErr StandardOpenDialog ( StandardFileReply reply)

StandardOpenDialog()

Availability:

Non-Carbon CFM: in Translation 1.0 and later
Carbon Lib: not available
Mac OS X: not available

◆ StandardPutFile()

void StandardPutFile ( ConstStr255Param  prompt,
ConstStr255Param  defaultName,
StandardFileReply reply 
)

StandardPutFile()

Availability:

Non-Carbon CFM: in InterfaceLib 7.1 and later
Carbon Lib: not available
Mac OS X: not available