These functions are used access any kind of database information (but not change it). In addition to accessing raw data fields, etc., many functions are included to get commonly needed information, for instance the current operator or the total amount due for a reservation.
(Back to Function Types List)
Function: ColorStatusMapSite
Result-type: Numeric
Arguments: rRecord ,dStart ,dEnd
Description: Returns the 'Map Status' value for a site given a date range, for use in Color Scheme definitions used on the Map view -- see the Fixed List "Map Status (Color Default)" for comparison values.
Function: ColorStatusResv
Result-type: Numeric
Arguments: rRecord [,dAsOfDate [, nAsOfPeriod]]
Description: Returns the 'Site Status' value for the reservation, optionally as of a particular date or period, for use in Color Scheme definitions -- see the Fixed List "Site Status (Color Default)" for comparison values. This should only be used for reservation-specific Queries, since it does not allow for open sites, etc.
Function: ColorStatusSite
Result-type: Numeric
Arguments: rRecord ,dDate [,nPeriod]
Description: Returns the 'Site Status' value for a site on a particular date (possibly with period), for use in Color Scheme definitions -- see the Fixed List "Site Status (Color Default)" for comparison values. This one should be used for a default global color scheme (since it's used on the Rack where open sites are shown).
Function: CurrentOpLevel
Result-type: Numeric
Arguments: (none)
Description: Returns the access level operator currently logged in. 0 = None logged in, 1 = Guest, 2 = Clerk, 3 = Reservations, 4 = Manager, 5 = Administrator
Function: CurrentOpName
Result-type: Text
Arguments: (none)
Description: Returns the name of the operator currently logged in, if any
Function: CurrentOpRec
Result-type: Record
Arguments: (none)
Description: Returns the Operator record for the operator currently logged in, if any
Function: Cust
Result-type: Record
Arguments: (none)
Description: Returns the Customer record of interest, if used where there's a specific customer (or reservation) we're to be evaluating an expression for (e.g. in a form, report or query). A shorter version of ThisCust().
Function: CustAgedDue
Result-type: Numeric
Arguments: rRecord, dSince, dAsOf
Description: Returns the aged amount due for the customer for the given time period
Function: CustDue
Result-type: Numeric
Arguments: rRecord [,dAsOf]
Description: Returns the total amount due for the customer, optionally as of a particular date
Function: CustNumResv
Result-type: Numeric
Arguments: rRecord
Description: Returns the number of reservations linked to the given customer record
Function: CustNumTran
Result-type: Numeric
Arguments: rRecord
Description: Returns the number of transactions linked to the given reservation or customer record
Function: CustOnlyDue
Result-type: Numeric
Arguments: rRecord
Description: Returns the total amount due for the customer excluding all reservations (total balance of customer-only transactions)
Function: CustResvAt
Result-type: Record
Arguments: rRecord, nIndex
Description: Returns the record for the nth reservation linked to the given customer record
Function: CustTranAt
Result-type: Record
Arguments: rRecord, nIndex
Description: Returns the record for the nth transaction linked to the given customer record
Function: FieldBool
Result-type: Boolean
Arguments: rRecord, cFieldName
Description: Gets the boolean value for the given field of a record. Will return FALSE if the field is not normally a boolean value
Function: FieldDate
Result-type: Date/Time
Arguments: rRecord, cFieldName
Description: Gets the date for the given field of a record. Will return a NULL value if the field is not normally a date value
Function: FieldIsBlank
Result-type: Boolean
Arguments: rRecord, cFieldName
Description: Returns 'T' if the specified field is designated as a 'blank' value (not set) -- this could be different than a '0' numeric value or FALSE boolean
Function: FieldIsEnabled
Result-type: Boolean
Arguments: rRecord, cFieldName
Description: Returns 'T' if the specified field is enabled for the table that the given record belongs to
Function: FieldNumLinks
Result-type: Numeric
Arguments: rRecord, cFieldName
Description: Returns the number of linked records in the specified link-list field. For instance to get the number of transactions for a given reservation. Basically the same as LinkedRecordCount()
Function: FieldRecAtLink
Result-type: Record
Arguments: rRecord, cFieldName, nIndex
Description: Returns the linked record at the given index of the specified link-list field. For instance to get a specific transaction for a given reservation. Basically the same as LinkedRecord()
Function: FieldText
Result-type: Text
Arguments: rRecord, cFieldName
Description: Gets the text for the given field of a record. Will return an empty string if the field is not normally a text value
Function: FieldTime
Result-type: Date/Time
Arguments: rRecord, cFieldName
Description: Gets the time for the given field of a record. Will return a NULL value if the field is not normally a time value
Function: FieldValue
Result-type: Numeric
Arguments: rRecord, cFieldName
Description: Gets the numeric value for the given field of a record. Will return 0 if the field is not normally a numeric value
Function: FindRecByFieldText
Result-type: Record
Arguments: cTableName, cFieldName, cMatchText [, bIgnoreCase [,nOccurrence]]
Description: Searches the table for a record with text for the given field matching the specified text. Optionally can ignore case and/or skip to the nth occurrence of a match
Function: FindRecByRecID
Result-type: Record
Arguments: cTableName, nRecID
Description: Searches the table for a record with the specified record ID (given as a numeric value)
Function: InvVendor
Result-type: Record
Arguments: rRecord
Description: Returns the vendor record associated with the given inventory item
Function: LinkedRecord
Result-type: Record
Arguments: rRecord, cFieldName [, nIndex]
Description: Returns the linked record, e.g. the record pointed to by a link field. If it's a list of links, an index (1-n) must be specified
Function: LinkedRecordCount
Result-type: Numeric
Arguments: rRecord, cFieldName
Description: Returns the number of linked records for a given linked-list field
Function: NullRecord
Result-type: Record
Arguments: (none)
Description: Returns a 'null' record pointer (primarily used for comparison with the results of record-type expressions)
Function: Park
Result-type: Record
Arguments: (none)
Description: Returns the Park record of interest, if used where there's a specific park (or site or reservation) we're to be evaluating an expression for (e.g. in a form, report or query). A shorter version of ThisPark().
Function: R
Result-type: Record
Arguments: eExpression
Description: Forces an 'Unknown' expression to look like a record expression -- it won't necessarily do conversion, it's simply used to satisfy argument type verifications where a function is used that returns an 'Unknown' type inside a function that requires a 'record' argument
Function: RecordID
Result-type: Numeric
Arguments: rRecord
Description: Returns the record ID (i.e. the Field_Index field) of the record
Function: RecordOrder
Result-type: Numeric
Arguments: rRecord
Description: Returns a number representing the logical position of the record in its table (e.g. for sorting)
Function: RecordTable
Result-type: Text
Arguments: rRecord
Description: Returns the name of the table that a given record belongs to
Function: Resv
Result-type: Record
Arguments: (none)
Description: Returns the Reservation record of interest, if used where there's a specific reservation we're to be evaluating an expression for (e.g. in a form, report or query). A shorter version of ThisResv()
Function: ResvAgedDue
Result-type: Numeric
Arguments: rRecord, dSince, dAsOf
Description: Returns the aged amount due for the reservation for the given time period
Function: ResvAutoCharges
Result-type: Numeric
Arguments: rRecord, [,fBest [, nMaxExtraDays [, fIncMonthly [, fIncMonthlyOnlyInitially [,fMonthlyOneMonth ] ] ]]]
Description: Returns the total expected auto-charges due for the reservation. Can include best rate w/extra days (default .F.,0), include Monthlies (for whole stay, default .F.), Monthly only initial partial-month calc (default .F.), and calc monthlies for next month only.
Function: ResvAutoReCalculate
Result-type: Boolean
Arguments: rRecord
Description: Recalculates the auto-charges for a reservation, if appropriate (e.g. if the auto-recalculate option is selected in the Auto-Rates setup, it's active, it should have auto-charges on it, etc.). Will not add charges to reservations with a monthly base type. Use this if other expressions might make changes that should require recalculation. Returns True if any changes were made to the reservation's charges.
Function: ResvBaseType
Result-type: Text
Arguments: rRecord
Description: Returns the base type of the reservation, in text format (e.g. 'Normal', 'Monthly', etc.)
Function: ResvCust
Result-type: Record
Arguments: rRecord
Description: Returns the customer record associated with the given reservation
Function: ResvDepositsPaid
Result-type: Numeric
Arguments: rRecord
Description: Returns the total of Deposits paid for the reservation
Function: ResvDue
Result-type: Numeric
Arguments: rRecord [,dAsOf]
Description: Returns the total amount due for the reservation, optionally as of a particular date
Function: ResvHasWeekdays
Result-type: Boolean
Arguments: rRecord
Description: Returns TRUE if the reservation is only for specific days of the week
Function: ResvIncludesWeekday
Result-type: Boolean
Arguments: rRecord
Description: Returns TRUE if the reservation's stay includes at least one date on the specified day of the week (1 = Sunday, etc.)
Function: ResvInRange
Result-type: Boolean
Arguments: rRecord, dStart, dEnd [, fBlocked]
Description: Returns TRUE if the reservation covers any dates in the given range, optionally including blocked dates. The default is to include blocked dates
Function: ResvIsActive
Result-type: Boolean
Arguments: rRecord [, bCheckedOut [, bWaiting [, bGuests ], bOwners]]]]
Description: Returns TRUE if the reservation is active (checked in, pending, confirmed, or guaranteed), excluding guests and owners by default. Optionally can consider active if checked-out, on waiting list, guest, or owner
Function: ResvIsLinked
Result-type: Boolean
Arguments: rRecord
Description: Returns True if the reservation is linked to any other reservations, either as a portfolio owner or a member
Function: ResvIsNonSyncedMember
Result-type: Boolean
Arguments: rRecord
Description: Returns True if the reservation is a non-synchronized member of any other reservation's portfolio
Function: ResvIsNonSyncedOwner
Result-type: Boolean
Arguments: rRecord
Description: Returns True if the reservation is an owner of a non-synchronized reservation portfolio
Function: ResvIsOnSpecificWeekday
Result-type: Boolean
Arguments: rRecord
Description: Returns TRUE if the reservation is only for specific days of the week, and includes the specific day of the week (1 = Sunday, etc.). Note: This doesn't guarantee that the reservation includes that day of the week, since the actual dates aren't checked (See ResvIncludesWeekday)
Function: ResvIsSubMember
Result-type: Boolean
Arguments: rRecord
Description: Returns True if the reservation is a sub-member of any other reservation's portfolio
Function: ResvIsSubMemberOfAnyone
Result-type: Boolean
Arguments: rRecord
Description: Returns True if the reservation is a sub-member of any other reservations, at any level above (e.g. possibly synchronized with sub-members)
Function: ResvIsSubOwner
Result-type: Boolean
Arguments: rRecord
Description: Returns True if the reservation is an owner of a sub-member reservation portfolio
Function: ResvIsSynced
Result-type: Boolean
Arguments: rRecord
Description: Returns True if the reservation is synchronized with any other reservations
Function: ResvIsSyncedMaster
Result-type: Boolean
Arguments: rRecord
Description: Returns True if the reservation is the synchronized master of any other reservations
Function: ResvIsSyncedMember
Result-type: Boolean
Arguments: rRecord
Description: Returns True if the reservation is a synchronized member of any other reservation's portfolio
Function: ResvIsSyncedOwner
Result-type: Boolean
Arguments: rRecord
Description: Returns True if the reservation is an owner of a synchronized reservation portfolio
Function: ResvLinkedMaster
Result-type: Record
Arguments: rRecord
Description: Returns the 'linked master' reservation record for the given reservation record, e.g. the top-level reservation
Function: ResvLinkedOwner
Result-type: Record
Arguments: rRecord
Description: Returns the linked 'owner' reservation record for the given reservation record (e.g. the direct owner, not necessarily the top level)
Function: ResvLinkedResvAt
Result-type: Record
Arguments: rRecord, nIndex
Description: Returns the Nth reservation record linked *below* the given reservation record (e.g. for looping through them), and any members linked below those, etc.)
Function: ResvLinkedTranMaster
Result-type: Record
Arguments: rRecord
Description: Returns the 'transaction master' reservation record for the given reservation record, e.g. the top-level synchronized or sub-member reservation
Function: ResvLinkedTranResvAt
Result-type: Record
Arguments: rRecord, nIndex
Description: Returns the Nth reservation record linked to the given reservation record (either above or below) that are suitable for combined billing. Note - this WILL include the reservation passed, in its proper nested location.
Function: ResvMemberResvAt
Result-type: Record
Arguments: rRecord, nIndex
Description: Returns the Nth reservation record linked *directly below* the given reservation record (e.g. for looping through them), but not any members linked below those
Function: ResvNights
Result-type: Numeric
Arguments: rRecord
Description: Returns the total number of nights in the reservation (not including any blocked dates)
Function: ResvNightsInRange
Result-type: Numeric
Arguments: rRecord, dStart, dEnd [, fBlocked]
Description: Returns the number of nights that the reservation covers in the given date range, optionally including blocked dates. The default is to include blocked dates. If the reservation is only for certain days of the week, only the included days of the week are counted.
Function: ResvNightsOverdue
Result-type: Numeric
Arguments: rRecord
Description: Returns the total number of nights the reservation payment is overdue
Function: ResvNightsUnpaid
Result-type: Numeric
Arguments: rRecord
Description: Returns the number of nights not paid in the reservation (not including any blocked dates)
Function: ResvNumLinkedResvs
Result-type: Numeric
Arguments: rRecord
Description: Returns the number of other reservations linked *below* the given reservation record (and any members linked below those, etc.)
Function: ResvNumLinkedTranResvs
Result-type: Numeric
Arguments: rRecord
Description: Returns the number of reservations linked to the given reservation record (either above or below) that are suitable for combined billing. Note - this WILL count the reservation passed.
Function: ResvNumMemberResvs
Result-type: Numeric
Arguments: rRecord
Description: Returns the number of other reservations linked *directly below* the given reservation record, but not any members linked below those
Function: ResvNumTran
Result-type: Numeric
Arguments: rRecord
Description: Returns the number of transactions linked to the given reservation or customer record
Function: SiteIsOpenPeriods
Result-type: Boolean
Arguments: rRecord, dFrom, nPeriodFrom, dTo, nPeriodTo, rResvExclude, [, bCheckedOut [, bWaiting [, bInactive [, bGuests [, bOwners]]]]]
Description: Returns TRUE if the site is open for reservations continuously for the given date/period range. Optionally can exclude a specific reservation (e.g. known to be on the site already), or include reservations checked out, inactive, on waiting list, guest, or owner.
Function: ResvOnSiteDate
Result-type: Record
Arguments: rRecord, dDate, rResvExclude, [, bCheckedOut [, bWaiting [, bGuests [, bOwners]]]]
Description: Returns the reservation on the given site for the given date. Optionally can exclude a specific reservation (e.g. known to be on the site already), or include reservations checked out, on waiting list, guest, or owner
Function: ResvOnSiteDatePeriod
Result-type: Record
Arguments: rRecord, dDate, nPeriod, rResvExclude, [, bCheckedOut [, bWaiting [, bGuests [, bOwners]]]]
Description: Returns the reservation on the given site for the given date & period. Optionally can exclude a specific reservation (e.g. known to be on the site already), or include reservations checked out, on waiting list, guest, or owner
Function: ResvPeriods
Result-type: Numeric
Arguments: rRecord
Description: Returns the total number of periods in a scheduled reservation (not including any blocked periods)
Function: ResvPreferences
Result-type: Text
Arguments: rRecord
Description: Returns a text string representing the preferences for the reservation (abbreviations of each preference)
Function: ResvSite
Result-type: Record
Arguments: rRecord
Description: Returns the site record associated with the given reservation
Function: ResvTranAt
Result-type: Record
Arguments: rRecord, nIndex
Description: Returns the record for the nth transaction linked to the given reservation record
Function: ResvWeekdays
Result-type: Text
Arguments: rRecord
Description: Returns a text string representing the days of the week included in the reservation
Function: Site
Result-type: Record
Arguments: (none)
Description: Returns the Site record of interest, if used where there's a specific site (or reservation) we're to be evaluating an expression for (e.g. in a form, report or query). A shorter version of ThisSite().
Function: SiteIsOpen
Result-type: Boolean
Arguments: rRecord, dFrom, dTo, rResvExclude, [, bCheckedOut [, bWaiting [, bInactive [, bGuests [, bOwners]]]]]
Description: Returns TRUE if the site is open for reservations continuously for the given date range. Optionally can exclude a specific reservation (e.g. known to be on the site already), or include reservations checked out, inactive, on waiting list, guest, or owner.
Function: SiteIsOpenPeriods
Result-type: Boolean
Arguments: rRecord, dFrom, nPeriodFrom, dTo, nPeriodTo, rResvExclude, [, bCheckedOut [, bWaiting [, bInactive [, bGuests [, bOwners]]]]]
Description: Returns TRUE if the site is open for reservations continuously for the given date/period range. Optionally can exclude a specific reservation (e.g. known to be on the site already), or include reservations checked out, inactive, on waiting list, guest, or owner.
Function: SiteNumResv
Result-type: Numeric
Arguments: rRecord
Description: Returns the number of reservations in the system for the given site record -- Primarily for use in Loop functions to enumerate reservations for a single site (faster than going through all reservation records), using SiteResvAt(n) to get each reservation record. Note that no assumptions can be made about the order of the reservations in this list.
Function: SiteOrder
Result-type: Numeric
Arguments: rRecord
Description: Returns a number representing the logical order of the site (e.g. for sorting)
Function: SiteResvAt
Result-type: Record
Arguments: rRecord, nIndex
Description: Returns the record for the nth reservation in the system for the given site record -- this is primarily for use in Loop functions using the function SiteNumResv(Site()) for the upper limit. Note that no assumptions can be made about the order of the reservations in this list.
Function: TableFieldExists
Result-type: Boolean
Arguments: cTableName, cFieldName
Description: Returns 'T' if the specified field exists for the table
Function: TableFieldIsEnabled
Result-type: Boolean
Arguments: cTableName, cFieldName
Description: Returns 'T' if the specified field is enabled for the table
Function: TableFieldJustification
Result-type: Text
Arguments: cTableName, cFieldName
Description: Returns the justification type for the specified field of the given table
Function: TableFieldLabel
Result-type: Text
Arguments: cTableName, cFieldName
Description: Returns the report heading/label for the specified field of the given table
Function: TableFieldNotes
Result-type: Text
Arguments: cTableName, cFieldName
Description: Returns the description notes for the specified field of the given table
Function: TableFieldPickName
Result-type: Text
Arguments: cTableName, cFieldName
Description: Returns the normal name (e.g. for selection lists) of the specified field of the given table
Function: TableFieldShortName
Result-type: Text
Arguments: cTableName, cFieldName
Description: Returns the short name of the specified field of the given table
Function: TableFieldType
Result-type: Text
Arguments: cTableName, cFieldName
Description: Returns the field type for the specified field of the given table
Function: TableNumRecs
Result-type: Numeric
Arguments: cTableName
Description: Returns the total number of records in the given table
Function: TableRecAt
Result-type: Record
Arguments: cTableName, nIndex
Description: Returns the record at the specified index position in the given table
Function: This
Result-type: Record
Arguments: (none)
Description: Returns the record of interest, if used where there's a specific record we're to be evaluating an expression for (e.g. in a report or query). Same as ThisRecord().
Function: ThisCust
Result-type: Record
Arguments: (none)
Description: Returns the Customer record of interest, if used where there's a specific customer (or reservation) we're to be evaluating an expression for (e.g. in a form, report or query). Same as the Cust() function.
Function: ThisCustNumTran
Result-type: Numeric
Arguments: (none)
Description: Returns the number of transactions linked to the given reservation or customer record
Function: ThisCustTranAt
Result-type: Record
Arguments: nIndex
Description: Returns the record for the nth transaction linked to the current customer of interest, if used where there's a specific customer (or reservation) we're to be evaluating an expression for (e.g. in a form, report or query)
Function: ThisListCount
Result-type: Numeric
Arguments: (none)
Description: Returns the number of records in the list of operating records, if used where a list of records is present (e.g. transactions in a receipt form or Transactions dialog, applicable records for a cell of a cross-tab report)
Function: ThisListRec
Result-type: Record
Arguments: nIndex
Description: Returns the Nth record in the list of operating records, if used where a list of records is present (e.g. transactions in a receipt form or Transactions dialog, applicable records for a cell of a cross-tab report)
Function: ThisPark
Result-type: Record
Arguments: (none)
Description: Returns the Park record of interest, if used where there's a specific park (or site or reservation) we're to be evaluating an expression for (e.g. in a form, report or query). Same as the Park() function.
Function: ThisRecord
Result-type: Record
Arguments: (none)
Description: Returns the record of interest, if used where there's a specific record we're to be evaluating an expression for (e.g. in a report or query). A shorter version is This().
Function: ThisResv
Result-type: Record
Arguments: (none)
Description: Returns the Reservation record of interest, if used where there's a specific reservation we're to be evaluating an expression for (e.g. in a form, report or query). Same as the Resv() function.
Function: ThisResvNumTran
Result-type: Numeric
Arguments: (none)
Description: Returns the number of transactions linked to the given reservation or customer record
Function: ThisResvTranAt
Result-type: Record
Arguments: nIndex
Description: Returns the record for the nth transaction linked to the current reservation of interest, if used where there's a specific reservation we're to be evaluating an expression for (e.g. in a form, report or query)
Function: ThisSite
Result-type: Record
Arguments: (none)
Description: Returns the Site record of interest, if used where there's a specific site (or reservation) we're to be evaluating an expression for (e.g. in a form, report or query). Same as the Site() function.
Function: ThisTran
Result-type: Record
Arguments: (none)
Description: Returns the Transaction record of interest, if used where there's a specific transaction we're to be evaluating an expression for (e.g. in a transaction report or query ). Same as the Tran() function.
Function: Tran
Result-type: Record
Arguments: (none)
Description: Returns the Transaction record of interest, if used where there's a specific transaction we're to be evaluating an expression for (e.g. in a transaction report or query ). A shorter version of ThisTran().
Function: TranBalAmount
Result-type: Numeric
Arguments: rRecord [,fIncludeDepApply [,fNegateDepApply]]
Description: Returns the amount of the transaction in proper credit/debit form for summing charges and payments, optionally including deposit applied, as positive or negative
Function: TranCust
Result-type: Record
Arguments: rRecord
Description: Returns the customer record associated with the given transaction
Function: TranInvItem
Result-type: Record
Arguments: rRecord
Description: Returns the inventory item record associated with the given Point of Sale transaction
Function: TranIsForInvItem
Result-type: Boolean
Arguments: rTransation, rInvItem
Description: Returns True if the given inventory item record is associated with the given Point of Sale transaction
Function: TranPmtAmtForCat
Result-type: Numeric
Arguments: rTransation, cCategory, bIncludeDeposits, fIncludeDepositsApplied
Description: Returns the amount of the given receipt-type record (Payment, Refund, Deposit, Dep. Applied, Xfer, Income or Expense) which is associated with the given Transaction Category. This interpolates the amount based on previous charge transactions that this payment could apply to. Use 'Uncategorized' for the category to get the amount not in any other category. Normally both bIncludeDeposits and bIncludeDepositsApplied should be True.
Function: TranResv
Result-type: Record
Arguments: rRecord
Description: Returns the reservation record associated with the given transaction
Page URL http://CampgroundMaster.com/shelp/database.html
Campground Master Home