GetNextNote

Use this procedure to retrieve notifications from the queue. This procedure returns the next notification queued for you. Figure 1 shows an example of the GetNextNote procedure.

Figure 1. GetNextNote example

   procedure GetNextNote
            (
        var    Note: NotificationInfoType;
                 ShouldWait: Boolean;
        var    ReturnCode: integer
            );
            external;

Parameter

Description

Note

Next notification is stored here when ReturnCode is OK.

ShouldWait

Set ShouldWait to TRUE if you want GetNextNote to wait until a notification becomes available. Set ShouldWait to FALSE if you want GetNextNote to return immediately. When ShouldWait is set to FALSE, ReturnCode is set to NOoutstandingNOTIFICATIONS if notification is not currently queued.

ReturnCode

Indicates success or failure of call. Possible return values are:

OK
NOoutstandingNOTIFICATIONS
NOTyetBEGUN

For a description of Pascal return codes, see Table 1.