|
FUNCTION FormatTimeString(rawTime$, formattedTime$) |
|
FUNCTION FormatTimeString(rawTime$, formattedTime$, numericTime$) |
|
FUNCTION FormatTimeString(rawTime$, formattedTime$, numericTime$, mask$) |
Formats a rawTime, into hours and minutes. If no mask given then the mask will be assumed to be "hh:mm P". If chosen will return not only the
formatted time but the internal numeric time as well. An override mask can be passed in for the formatted time.
|
| Parameter | Description |
|---|
| rawTime$ |
[input, string] raw time to format |
| formattedTime$ |
[output, string] formatted representation of the raw time, from the given mask. |
| numericTime$ |
[output, string] {optional} internal numeric time formulated from the raw time |
| mask$ |
[input, string] {optional} override mask for the formatted time if none given, will be assumed "hh:mm P" |
|
| Returns |
Always returns retSUCCESS(1) |
|
|
FUNCTION LOCAL ClassValidateTime(col$, val$) |
Class validation method for the class of TIME. This method will validate the time entered and format it using FormatTimeString()
|
| Parameter | Description |
|---|
| col$ |
[input, string] Column name that contains the time value to be validated |
| val$ |
[input, string] Value to be validated. |
|
|
|
| Value | Description |
|---|
| retSUCCESS(1) |
time value is valid |
| retFAILURE(0) |
time valid is invalid. |
|
|
FUNCTION LOCAL ConvertDecimalTime(rawTime$, formattedTime$) |
|
FUNCTION LOCAL ConvertDecimalTime(rawTime$, formattedTime$, mask$) |
Converts time from decimal format to masked format
|
| Parameter | Description |
|---|
| rawTime$ |
[input, string] raw time to be converted and formatted |
| formattedTime$ |
[output, string] raw time formatted with hh:mm P mask, unless overridden with mask |
| mask$ |
[input, string] {optional} mask to be used to format raw time. |
|
| Returns |
[boolean] returns retSUCCESS(1) if conversion is successful, retFAILURE(0) if conversion is not successful |
|
