Legacy Document

Important: The information in this document is obsolete and should not be used for new development.

Chapter 3 - Standard File Package / Standard File Package Reference

Standard File Package Routines / Saving Files

SFPPutFile
Use the SFPPutFile procedure when your application requires more control over the Save dialog box than is possible using SFPutFile.
PROCEDURE SFPPutFile (where: Point; prompt: Str255;
                        origName: Str255; dlgHook: DlgHookProcPtr;
                        VAR reply: SFReply; dlgID: Integer;
                        filterProc: ModalFilterProcPtr);
where
The upper-left corner of the dialog box, in global coordinates.
prompt
The prompt message to be displayed over the text field.
origName
The initial name of the file, if any.
dlgHook
A pointer to your dialog hook function, which handles item selections received from the Dialog Manager. Specify a value of NIL if you have not added any items to the dialog box and want the standard items handled in the standard ways. See "Writing a Dialog Hook Function" on page 3-21 for a description of the dialog hook function.
reply
The reply record, which SFPPutFile fills in before returning.
dlgID
The resource ID of a customized dialog template. To use the standard template, set this parameter to -3999.
filterProc
A pointer to your modal-dialog filter function, which determines how the ModalDialog procedure filters events when called by the SFPPutFile procedure. Specify a value of NIL if you are not supplying your own function. See "Writing a Modal-Dialog Filter Function" on page 3-28 for a description of the modal-dialog filter function.

DESCRIPTION
The SFPPutFile procedure is an alternative to SFPutFile when you want to display
a customized Save dialog box or handle the default dialog box in a customized way. During the dialog, SFPPutFile gets and handles events (possibly with the assistance of application-defined callback routines) until the user completes the interaction, either by selecting a name and authorizing the save operation or by canceling the save operation. SFPPutFile returns the user's input in a record of type SFReply.

ASSEMBLY-LANGUAGE INFORMATION
The trap macro and routine selector for SFPPutFile are
Trap macro Selector
_Pack3 $0003

SPECIAL CONSIDERATIONS
Because SFPPutFile may move memory, you should not call it at interrupt time.