This function returns the value of the particular field in a record to which the data browse cursor is currently referencing. This function uses iSession as an argument which is previously returned by the SchdSpecialItemOpen function and the field name of the value to be returned.
Syntax
STRING SchdSpecialItemGetField(LONG Session, STRING Field)
Session
Current special day group browsing session obtained by SchdSpecialItemOpen
Field
Specifies via a comma delimited string the columns to be returned during the browse. An empty string indicates that the server will return every available column. Supported fields are:
GROUPNAME: The group name of the special day
NAME: The name of the special day
DAY: The special day. The time is returned as a Timestamp value. Use StrToTimestamp() to get a TIMESTAMP data value
ID: The unique ID of the special day. Every special day is assigned a unique ID.
Return Value
The value of the specified field as a string. An empty string may or may not be an indication that an error has been detected. The last error should be checked in this instance to determine if an error has actually occurred.
Related Functions
SchdSpecialItemOpen, SchdSpecialItemClose, SchdSpecialItemNext, SchdSpecialItemPrev, SchdSpecialItemFirst, SchdSpecialItemNumRecords
Example
TIMESTAMP tsDay = StrToTimestamp(SchdSpecialItemGetField(hSession,"Day"),15,0);
See Also
Published June 2018