User Interaction

Functions that involve some kind of interaction with the user are included in this category, such as showing message prompts or opening a particular user-interface dialog like Reservation Details.

Description:

Opens a generic Edit/Details type dialog (customizable) for the record passed. A custom "Edit Generic Record" Add-on type Dialog Definition must be defined for the given record type, ready to enter data for a new record. The Edit dialog will not have the browsing/add/delete controls, so only the new record can be accessed. Returns the record reference of the record added, or NullRecord() if the record is not added (Cancel clicked or no data entered).

Description:

Performs the 'Auto-Checkout All of today's departures (shown or not)' function, as from the right-click menus, with all appropriate validations and prompts. Returns FALSE if error or if the function is closed without changes, or returns TRUE if changes are made.

Description:

Creates a backup of the database to the specified file (which should include the full path, file name and file extension). Compression is optional -- if fCompress is not specified then it will be compressed by default. Return indicates success of backup file creation.

Description:

Checks online for any Custom-site reservation requests waiting to be downloaded, and returns how many new requests were found. All appropriate Online Reservations settings must be set up beforehand. The bNoPrompts flag may be set to prevent error prompts and bSilent may be set to hide the progress dialog, however the system will probably be unresponsive during this time. The default parameters are all False (show progress, show errors).

Description:

Checks online for any reservation request E-mail messages waiting to be downloaded, and returns how many new requests were found. All appropriate Online Reservations settings must be set up beforehand. The bNoPrompts flag may be set to prevent error prompts and bSilent may be set to hide the progress dialog, however the system will probably be unresponsive during this time. The default parameters are all False (show progress, show errors).

Description:

Checks online for any iCal file reservation requests waiting to be downloaded, and returns how many new requests were found. All appropriate Online Reservations settings must be set up beforehand. The bNoPrompts flag may be set to prevent error prompts and bSilent may be set to hide the progress dialog, however the system will probably be unresponsive during this time. The default parameters are all False (show progress, show errors).

Description:

Delays all user interaction for the specified number of milliseconds (1/1000ths of a second, e.g. 5000 = 5 seconds). The maximum delay possible at once is 1 minute (60000 ms) -- use a loop if longer times are needed. Note that the accuracy of this not guaranteed, and the usable granularity is generally only 100 ms increments. This function won't return until the delay is complete, and the return value is always True.

Description:

Opens the Customer Transactions dialog for the customer record passed. Returns FALSE if the dialog is closed without changes, or returns TRUE if changes are made.

Description:

Opens the Edit Inventory Item dialog for the POS inventory item record passed. Returns FALSE if the dialog is closed without changes, or returns TRUE if changes are made.

Description:

Opens a generic Edit/Details dialog (customizable) for the record passed. A custom Dialog Definition must be defined for the given record type. Set bBrowse to allow browsing to other records, bAllowAdd to allow adding new ones, and bAllowDelete to allow deleting records. (All options default to False.) Returns False if the dialog is closed without changes, or returns True if changes are made.

Description:

Opens the Reservation Details dialog for the reservation record passed. Returns FALSE if the dialog is closed without changes, or returns TRUE if changes are made.

Description:

Opens the Reservation Transactions dialog for the reservation record passed. Optionally may have it enter the Select Rates function immediately (show the Select Rates dialog). Returns FALSE if the dialog is closed without changes, or returns TRUE if changes are made.

Description:

Opens the Unbound Transactions dialog, optionally using the transaction record passed as the transaction/receipt to edit. Returns FALSE if the dialog is closed without changes, or returns TRUE if changes are made.

Description:

Generates the iCal files and optionally uploads them to a web site via FTP. The settings in Maintenance / Online Reservations / Other Online interfaces will be used, and must be set up beforehand. If uploading, the settings in Online Reservations - Connections & Options / iCal must also be set up. The bNoPrompts flag may be set to prevent error prompts and bSilent may be set to hide the progress dialog, however the system will probably be unresponsive during this time. The default parameters are all False (generate pages only, not silent, show errors). The return value indicates whether it was successful.

Description:

Generates the web site vacancy grids and optionally uploads them to a web site via FTP. The settings in File / Export to Web Vacancy will be used, and must be set up beforehand. If uploading, the settings in Online Reservations - Connections & Options / Export to Web must also be set up. The bNoPrompts flag may be set to prevent error prompts and bSilent may be set to hide the progress dialog, however the system will probably be unresponsive during this time. The default parameters are all False (generate pages only, not silent, show errors). The return value indicates whether it was successful.

Description:

Opens the Find Customer dialog, optionally with a starting Filter By selection and Search Text (note that the Filter By argument must exactly match the selection in the dialog's drop-down list). If bCancelAdds is True, then the Cancel button shows 'Cancel / Add New' but it doesn't actually add one in this function. Returns the customer's record if one is selected to 'Use', or a Null record if the dialog is closed with Cancel.

Description:

Opens the Find Inventory Item dialog, optionally with starting Search Text. Returns the item's record if one is selected to 'Use', or a Null record if the dialog is closed with Cancel.

Description:

Opens the Find Reservation dialog, optionally with a starting Filter By selection and Search Text (note that the Filter By argument must exactly match the selection in the dialog's drop-down list). Returns the reservation's record if one is selected to 'Use', or a Null record if the dialog is closed with Cancel.

Description:

Opens the Find Vendor dialog, optionally with a starting Filter By selection and Search Text (note that the Filter By argument must exactly match the selection in the dialog's drop-down list). If bCancelAdds is True, then the Cancel button shows 'Cancel / Add New' but it doesn't actually add one in this function. Returns the vendor's record if one is selected to 'Use', or a Null record if the dialog is closed with Cancel.

Description:

Uploads a file to an FTP server. Defaults are to show progress dialog (bShowProgress=.T.) and show any error prompts (bShowPrompts=.T.) The return value indicates whether it was successful.

Description:

Gets the 'Subject' for the given named form, for the given record. The Printer type for the form must be 'Text output (or E-mail)', for instance an E-mail type form, and the form must have the 'Subject expression' filled in (or else the result is blank).

Description:

Gets the formatted text for the given named form, for the given record. The Printer type for the form must be 'Text output (or E-mail)', for instance an E-mail type form. Optionally include print-some options: 0=All, 1=new, 2=since zero balance, 3=since zero or credit balance, 4=since date, 5 = between dates. If since date or between dates, starting date must be included. If between date, ending date must be included. Can also set bShowPrevious for whether Previous Balance and Balance Due is shown (defaults to True).

Description:

Returns True if there are any dialog windows or message prompt windows open. This can be used to determine whether the user is in the middle of something, or the system is waiting for the user to respond.

Description:

Execute a main menu command, as if the operator selected it. Note that operator level and other authorization level checking may or may not be performed, so use this function cautiously. Also note that menu commands are numeric command IDs, which could change in future versions. This function won't return until the command is complete, and the return value is always True. You can find the command values in the Expression builder (e.g. Insert Expression Element) -- select Fixed List Values, Menu Command Values.

Description:

Shows a message in a prompt window. The nButtons parameter can be 0 for OK, 1 for OK & Cancel, 2 for Yes & No, or 3 for Yes, No, & Cancel. The nIcon parameter can be 0 for none, 1 for Warning/Exclamation, 2 for Error/Stop, or 3 for Information. Returns the button clicked : 0 = Cancel, 1 = OK, 2 = Yes, 3 = No.

Description:

Opens the Point of Sale dialog, optionally using the transaction record passed as the transaction/receipt to edit. Returns FALSE if the dialog is closed without changes, or returns TRUE if changes are made.

Description:

Opens the Point of Sale dialog for the designated customer. Transactions will be added to the customer, and don't necessarily need to be paid. Returns FALSE if the dialog is closed without changes, or returns TRUE if changes are made.

Description:

Opens the Point of Sale dialog for the designated reservation. Transactions will be added to the reservation, and don't necessarily need to be paid. Returns FALSE if the dialog is closed without changes, or returns TRUE if changes are made.

Description:

Prints the given named form for the given record. Must indicate whether a Print Preview window is shown and whether a Printer Setup dialog is shown before printing. You may also specify what transactions to print: 0=All, 1=New (most recent), 2=unbalanced (since last 0 balance), 3=unpaid (since last 0 or credit balance), 4=since date (also must specify the starting date), 5=between dates (specify start and end dates). Can also set bShowPrevious for whether Previous Balance and Balance Due is shown (defaults to True).

Description:

Prints the given form for the record list in the current context (e.g. ThisListRec/Count). Must indicate whether a Print Preview window is shown and whether a Printer Setup dialog is shown before printing. You may also specify what transactions to print: 0=All, 1=New (most recent), 2=unbalanced (since last 0 balance), 3=unpaid (since last 0 or credit balance), 4=since date (also must specify the starting date), 5=between dates (specify start and end dates). Can also set bShowPrevious for whether Previous Balance and Balance Due is shown (defaults to True).

Description:

Queues up an E-mail message for batch sending, using the internal SMTP functionality. The Online Setup for the SMTP settings must be configured and enabled. If the From name & address are blank, it will use the defaults from the SMTP settings. Optionally can include one or more file attachments (the full path must be specified for each -- use the '|' character between multiple file names). The return value indicates whether it was queued successfully. Use ResetEmailQueue() before sending, and SendQueuedEmails() to initiate the batch sending after all E-mails are queued.

Function:	ResvAddGuest
Result-type:	Boolean
Arguments:	rReservation
Description:	Performs the 'Add a Guest to this Reservation' function on the specified reservation, as from the right-click menus, with all appropriate validations and prompts. Returns FALSE if error or if the function is closed without changes, or returns TRUE if changes are made.

Function:	ResvAddNewMaster
Result-type:	Boolean
Arguments:	rReservation
Description:	Performs the 'Add New Linked Master reservation' function on the specified reservation, as from the right-click menus, with all appropriate validations and prompts. Returns FALSE if error or if the function is closed without changes, or returns TRUE if changes are made.

Function:	ResvAddNonSynced
Result-type:	Boolean
Arguments:	rReservation
Description:	Performs the 'Add Non-Synchronized reservations' function on the specified reservation, as from the right-click menus, with all appropriate validations and prompts. Returns FALSE if error or if the function is closed without changes, or returns TRUE if changes are made.

Function:	ResvAddSubmember
Result-type:	Boolean
Arguments:	rReservation
Description:	Performs the 'Add Sub-member reservations' function on the specified reservation, as from the right-click menus, with all appropriate validations and prompts. Returns FALSE if error or if the function is closed without changes, or returns TRUE if changes are made.

Function:	ResvAddSynced
Result-type:	Boolean
Arguments:	rReservation
Description:	Performs the 'Add Synchronized reservations' function on the specified reservation, as from the right-click menus, with all appropriate validations and prompts. Returns FALSE if error or if the function is closed without changes, or returns TRUE if changes are made.

Function:	ResvAssignSite
Result-type:	Boolean
Arguments:	rReservation
Description:	Performs the 'Assign or Change Site' function on the specified reservation, as from the right-click menus, with all appropriate validations and prompts. Returns FALSE if error or if the function is closed without changes, or returns TRUE if changes are made.

Function:	ResvCancel
Result-type:	Boolean
Arguments:	rReservation
Description:	Performs the 'Cancel Reservation' function on the specified reservation (or change cancel reason, if already canceled), as from the right-click menus, with all appropriate validations and prompts. Returns FALSE if error or if the function is closed without changes, or returns TRUE if changes are made.

Function:	ResvChangeCustomer
Result-type:	Boolean
Arguments:	rReservation
Description:	Performs the 'Change Customer' function on the specified reservation, as from the right-click menus, with all appropriate validations and prompts. Returns FALSE if error or if the function is closed without changes, or returns TRUE if changes are made.

Function:	ResvCheckIn
Result-type:	Boolean
Arguments:	rReservation
Description:	Performs the 'Check In' function on the specified reservation, as from the right-click menus, with all appropriate validations and prompts. Returns FALSE if error or if the function is closed without changes, or returns TRUE if changes are made.

Function:	ResvCheckOut
Result-type:	Boolean
Arguments:	rReservation
Description:	Performs the 'Check Out' function on the specified reservation, as from the right-click menus, with all appropriate validations and prompts. Returns FALSE if error or if the function is closed without changes, or returns TRUE if changes are made.

Function:	ResvConfirm
Result-type:	Boolean
Arguments:	rReservation
Description:	Performs the 'Confirm Reservation' function on the specified reservation, as from the right-click menus, with all appropriate validations and prompts. Returns FALSE if error or if the function is closed without changes, or returns TRUE if changes are made.

Function:	ResvEmailCustReceipt
Result-type:	Boolean
Arguments:	rReservation
Description:	Performs the 'E-mail Customer Form' function on the specified reservation, as from the right-click menus, with all appropriate validations and prompts. Returns FALSE if error or if the function is closed without changes, or returns TRUE if changes are made.

Function:	ResvEmailReceipt
Result-type:	Boolean
Arguments:	rReservation
Description:	Performs the 'E-mail Reservation Receipt or other Form' function on the specified reservation, as from the right-click menus, with all appropriate validations and prompts. Returns FALSE if error or if the function is closed without changes, or returns TRUE if changes are made.

Function:	ResvGuarantee
Result-type:	Boolean
Arguments:	rReservation
Description:	Performs the 'Guarantee Reservation' function on the specified reservation, as from the right-click menus, with all appropriate validations and prompts. Returns FALSE if error or if the function is closed without changes, or returns TRUE if changes are made.

Function:	ResvLinkAsNonSynced
Result-type:	Boolean
Arguments:	rReservation
Description:	Performs the 'Link this reservation to another, as Non-Synchronized' function on the specified reservation, as from the right-click menus, with all appropriate validations and prompts. Returns FALSE if error or if the function is closed without changes, or returns TRUE if changes are made.

Function:	ResvLinkAsSubMember
Result-type:	Boolean
Arguments:	rReservation
Description:	Performs the 'Link this reservation to another, as Sub-member' function on the specified reservation, as from the right-click menus, with all appropriate validations and prompts. Returns FALSE if error or if the function is closed without changes, or returns TRUE if changes are made.

Function:	ResvLinkAsSynced
Result-type:	Boolean
Arguments:	rReservation
Description:	Performs the 'Link this reservation to another, as Synchronized' function on the specified reservation, as from the right-click menus, with all appropriate validations and prompts. Returns FALSE if error or if the function is closed without changes, or returns TRUE if changes are made.

Function:	ResvNewBlockDate
Result-type:	Boolean
Arguments:	rReservation, dDate [, nPeriod]
Description:	Performs the 'This is New Blocked Date' function on the specified reservation, on the specified date (optionally with schedule period), as from the right-click menus, with all appropriate validations and prompts. Returns FALSE if error or if the function is closed without changes, or returns TRUE if changes are made.

Function:	ResvNewLastDate
Result-type:	Boolean
Arguments:	rReservation, dDate [, nPeriod]
Description:	Performs the 'This is New Last Date' function on the specified reservation, on the specified date (optionally with schedule period), as from the right-click menus, with all appropriate validations and prompts. Returns FALSE if error or if the function is closed without changes, or returns TRUE if changes are made.

Function:	ResvNewStartDate
Result-type:	Boolean
Arguments:	rReservation, dDate [, nPeriod]
Description:	Performs the 'This is New Start Date' function on the specified reservation, on the specified date (optionally with schedule period), as from the right-click menus, with all appropriate validations and prompts. Returns FALSE if error or if the function is closed without changes, or returns TRUE if changes are made.

Function:	ResvPrintCustEnvelope
Result-type:	Boolean
Arguments:	rReservation
Description:	Performs the 'Print Customer Envelope or Form' function on the specified reservation, as from the right-click menus, with all appropriate validations and prompts. Returns FALSE if error or if the function is closed without changes, or returns TRUE if changes are made.

Function:	ResvPrintCustReceipt
Result-type:	Boolean
Arguments:	rRecord
Description:	Performs the 'Print Customer Receipt' function on the specified reservation or customer record, as from the right-click menus, with all appropriate validations and prompts. Returns FALSE if error or if the function is closed without changes, or returns TRUE if changes are made.

Function:	ResvPrintReceipt
Result-type:	Boolean
Arguments:	rReservation
Description:	Performs the 'Print Reservation Receipt or Form' function on the specified reservation, as from the right-click menus, with all appropriate validations and prompts. Returns FALSE if error or if the function is closed without changes, or returns TRUE if changes are made.

Function:	ResvQuickInfoText
Result-type:	Text
Arguments:	rReservation, dDate [, nPeriod]
Description:	Gets the default Quick-Info window text for the specified Reservation, on the specified date (optionally with schedule period).

Function:	ResvRemoveBlockDate
Result-type:	Boolean
Arguments:	rReservation
Description:	Performs the 'Remove Blocked Dates' function on the specified reservation, as from the right-click menus, with all appropriate validations and prompts. Returns FALSE if error or if the function is closed without changes, or returns TRUE if changes are made.

Function:	ResvShowConflicting
Result-type:	Boolean
Arguments:	rReservation
Description:	Performs the 'Show Conflicting Reservations' function on the specified reservation, as from the right-click menus, with all appropriate validations and prompts. Returns FALSE if error or if the function is closed without changes, or returns TRUE if changes are made.

Function:	ResvSplitAtDate
Result-type:	Boolean
Arguments:	rReservation, dDate [, nPeriod]
Description:	Performs the 'Split Reservation at this date' function on the specified reservation, on the specified date (optionally with schedule period), as from the right-click menus, with all appropriate validations and prompts. Returns FALSE if error or if the function is closed without changes, or returns TRUE if changes are made.

Function:	ResvTipText
Result-type:	Text
Arguments:	rReservation
Description:	Gets the default mouse-over tip text for the specified Reservation

Function:	SaveDatabase
Result-type:	Boolean
Arguments:	(none)
Description:	Saves the database (making sure all changes are broadcast to other workstations and saved to log, etc.). Return value is always True

Description:

Sends an E-mail message, using the internal SMTP functionality. The Online Setup for the SMTP settings must be configured and enabled. If the bPreview flag is set, the message will be shown in a window first, where it can be edited. If the From name & address are blank, it will use the defaults from the SMTP settings. Optionally can include one or more file attachments (the full path must be specified for each -- use the '|' character between multiple file names). The return value indicates whether it was successful.

Description:

Sends an E-mail message, using the internal SMTP functionality. This version includes the record you're sending it for, so it will appear in that record's Audit Trail. The Online Setup for the SMTP settings must be configured and enabled. If the bPreview flag is set, the message will be shown in a window first, where it can be edited. If the From name & address are blank, it will use the defaults from the SMTP settings. Optionally can include one or more file attachments (the full path must be specified for each -- use the '|' character between multiple file names). The return value indicates whether it was successful.

Description:

Sends a text message to the designated workstation. This is primarily for custom use -- by default, the message is simply displayed as a pop-up, however you can also intercept it to create custom functionality using an Event Action ("Network Text Message Received" -- the sending WS will be in ThisValue(), the message will be in ThisTextValue() ).

Description:

Sends a command to the Pole Display, if present (Point of Sale option required). The command string must include any control sequences necessary, as 'escape' values like -. Returns True if no errors occur and the pole display is enabled.

Description:

Sends the Queued E-mails, using normal Batch E-mail settings for the number to send at a time and pausing between sub-batches. Resets the Batch E-mail queue after sending, whether it's successful or not. For use with the QueueEmail() function. Return value indicates whether all were sent successfully. There is no information about which ones were sent successfully, if any, if there is an error. Can optionally skip adding each one to the audit trail.

Description:

Uses the system 'ShellExecute' function to open a document, execute a program, explore a folder or other functions. See Windows development specifications for details.

Description:

Shows a query in a dialog window, with optional start & end dates and search text. If you don't want From & To date selections on the dialog, set bUseDates to False (dStart and dEnd will still be used for the query, but the user won't be able to change them). If you want the query to operate like a Search function and return the record by the user, then set bAsSearch to True. The return value will be the record selected from the query list (or it will be a Null record if it was canceled or if bAsSearch is False).

Description:

Opens a Raw Data Tables dialog for the given table. Optionally allow adding, moving, sorting or deleting records in the table (all options default to False if not provided). If it's a Pick List, set bPickList. Can also show allow showing links as index values instead of the relative text. Return value is True if data changes have been made.

Description:

Opens a 'Setup' type dialog for the given table, showing a list of records in the table and allowing adding/editing/deleting/etc. Must also provide a list of Field ID's to show in the list (comma-separated text ID's). Set bAllowAdd to allow adding new ones, and bAllowDelete to allow deleting records. In order to Edit a record in the list, an "Edit Generic Record" Add-on type Dialog Definition must exist for the record (table) type. Return value is True if any data changes have been made.

Function:	ShowUnassignedForDate
Result-type:	Boolean
Arguments:	dDate
Description:	Performs the 'View Unassigned reservations for this date' function on the specified date, as from the right-click menus, with all appropriate validations and prompts. If site is available, will make it unavailable, and vice versa. Returns FALSE if error or if the function is closed without changes, or returns TRUE if changes are made.

Function:	SiteAdvanceNext
Result-type:	Boolean
Arguments:	rSite, dDate [, nPeriod]
Description:	Performs the 'Advance Next Reservation to this date' function on the specified site on the specified date (optionally with schedule period), as from the right-click menus, with all appropriate validations and prompts. Returns FALSE if error or if the function is closed without changes, or returns TRUE if changes are made.

Function:	SiteBlockPrevious
Result-type:	Boolean
Arguments:	rSite, dDate [, nPeriod]
Description:	Performs the 'Block Previous Reservation to this date' function on the specified site on the specified date (optionally with schedule period), as from the right-click menus, with all appropriate validations and prompts. Returns FALSE if error or if the function is closed without changes, or returns TRUE if changes are made.

Function:	SiteChangeAvailable
Result-type:	Boolean
Arguments:	rSite, dDate
Description:	Performs the 'Make Site Available (or Unavailable) this date' function on the specified site on the specified date, as from the right-click menus, with all appropriate validations and prompts. If site is available, will make it unavailable, and vice versa. Returns FALSE if error or if the function is closed without changes, or returns TRUE if changes are made.

Function:	SiteChangeDirty
Result-type:	Boolean
Arguments:	rSite
Description:	Performs the 'Site Is Dirty/Clean' function on the specified site, as from the right-click menus, with all appropriate validations and prompts. If currently Dirty, makes it Clean, and vice versa. Returns FALSE if error or if the function is closed without changes, or returns TRUE if changes are made.

Function:	SiteExtendPrevious
Result-type:	Boolean
Arguments:	rSite, dDate [, nPeriod]
Description:	Performs the 'Extend Previous Reservation to this date' function on the specified site on the specified date (optionally with schedule period), as from the right-click menus, with all appropriate validations and prompts. Returns FALSE if error or if the function is closed without changes, or returns TRUE if changes are made.

Function:	SiteFindReservations
Result-type:	Boolean
Arguments:	rSite
Description:	Performs the 'Find all Reservations for this site' function on the specified site, as from the right-click menus, with all appropriate validations and prompts. Returns FALSE if error or if the function is closed without changes, or returns TRUE if changes are made.

Function:	SiteQuickInfoText
Result-type:	Text
Arguments:	rReservation [, dDate]
Description:	Gets the default Quick-Info window text for the specified Site, (optionally on a particular date).

Function:	SiteShowResvsForDates
Result-type:	Boolean
Arguments:	rSite, dFromDate, dToDate
Description:	Performs the 'Multiple Reservation Details' function on the specified site for the specified date range, as from the right-click menus, with all appropriate validations and prompts. Returns FALSE if error or if the function is closed without changes, or returns TRUE if changes are made.

Function:	SiteTipText
Result-type:	Text
Arguments:	rSite
Description:	Gets the default mouse-over tip text for the specified Site

Function:	SiteWorkOrders
Result-type:	Boolean
Arguments:	rSite
Description:	Performs the 'Site work orders' function on the specified site, as from the right-click menus, with all appropriate validations and prompts. Returns FALSE if error or if the function is closed without changes, or returns TRUE if changes are made.

Description:

Start a new reservation (open New Reservation dialog), optionally providing the customer, site, first night and last night. The Site and/or Customer may be NullRecord() to start without a customer or site specified. Returns the new reservation created, or NullRecord() if it was not created.

Description:

Returns the date and time that the last user-interface dialog was closed. This can be used to determine when the user was last doing something on the computer that required interaction.

Description:

Returns the date and time that the user last moved the mouse or closed a dialog. This can be used to determine when the user was last doing something on the computer.