Legacy Document

Inside Macintosh: Interapplication Communication /

Chapter 2 - Edition Manager / Edition Manager Reference

Edition Manager Routines / Displaying Dialog Boxes

SectionOptionsDialog

Use the SectionOptionsDialog function to display the publisher options and subscriber options dialog boxes on the user's screen.

FUNCTION SectionOptionsDialog  
                     (VAR reply: SectionOptionsReply): OSErr;

reply

The reply parameter contains a section options reply record. You specify a handle to the publisher's or subscriber's section record in the sectionH field of this record. The SectionOptionsDialog function returns information concerning the user's actions in the canceled, changed, and action fields.

TYPE SectionOptionsReply = 
   RECORD
      canceled:   Boolean;          {user canceled dialog box}
      changed:    Boolean;          {changed the section record}
      sectionH:   SectionHandle;    {handle to the specified }
                                    { section record}
      action:     ResType;          {action codes}
   END;

Field Description

canceled

The SectionOptionsDialog function returns in this field a value that indicates whether the user canceled the dialog box. The function returns TRUE in the canceled field if the user canceled the dialog box. Otherwise, the function returns FALSE in this field.

changed

The SectionOptionsDialog function returns TRUE in this field if the user changed the section record. For example, the update mode may have changed. Otherwise, the function returns FALSE in this field.

sectionH

A handle to the section record for the section the user selected.

action

The SectionOptionsDialog function returns in this field the code for one of five user actions: action code 'read' for user selection of the Get Edition Now button, action code 'writ' for user selection of the Send Edition Now button, action code 'goto' for user selection of the Open Publisher button, action code 'cncl' for user selection of the Cancel Publisher or Cancel Subscriber button, or action code ' ' ($20202020) for user selection of the OK button.

DESCRIPTION

The SectionOptionsDialog function displays the appropriate options dialog box for the specified section record. The function displays information about the subscriber or publisher, such as its latest edition and current update mode setting, and allows the user to perform various actions. The SectionOptionsDialog function handles all user interaction until the user selects a button. The function returns the user's action in the action field of the reply parameter; your application should then perform the corresponding action.

RESULT CODES

noErr	0	No error
memFullErr	-108	Memory full

SEE ALSO

For illustrations of the section options dialog box, see Figure 2-13 through Figure 2-16 beginning on page 2-43. For an example of the use of SectionOptionsDialog, see Listing 2-8 beginning on page 2-46. For a description of the section record, see page 2-72.