prg_date_from_string_convert()
Abstract
Converts the string representation of a date to PrgT_Date.
Syntax
prg_date_from_string_convert (date_time_string, string_format, options, date_time_ptr)
| Argument | Type | Description |
|---|---|---|
date_time_string |
const char * |
Date string to convert (must not be empty). |
string_format |
PrgT_Date_String_Format |
Format of date_time_string (see Details). |
options |
int |
Unused. |
date_time_ptr |
PrgT_Date * |
Object to receive converted date (must not be NULL). |
Return Type
PrgT_Compcode
PrgC_Compcode_Success if the conversion is successful; PrgC_Compcode_Failure otherwise.
Header
prg_date.h
Details
This function converts a string representation of a date to a PrgT_Date object.
string_format specifies the format of the string. This must be PrgC_Date_String_Format_Standard, which specifies a string in the C standard format: “12:34:56.789 Mar 19 2008”.
The date and time are assumed to be for the local time zone; no time zone conversion is done.