ar_convert_time_to_string

void ar_convert_time_to_string (short board, short displayFormat, pAR_TIMETAG_TYPE timeIn, char * timeString);

Purpose

This function converts the time value provided in the timeIn structure to a character string representation of date/time, format based on what is specified via the displayFormat parameter.  The supplied time format (LSB resolution) must be specified in the timeIn structure member timeTagFormat, representing the resolution of the respective timeTag member data.

Parameters

Input

Name

Type

Description

board

short

(input) Device Number of the board to reference, (valid range is 0-15).

displayFormat

short

Requested format for the returned time string conversion

AR_TD_REL_MIDNIGHT and AR_TD_IRIG    Day of Year Format
    defined as "(DDD)hh:mm:ss.uuuuuu"

AR_TD_DATE      Month/Day of Year Format
    defined as "(MM/DD)hh:mm:ss.uuuuuu"

timeIn

pAR_TIMETAG_TYPE

(input) The time-tag data structure containing the time of year value to convert, (passed by reference).  Defined as follows:


typedef struct {
        
TIME_TAG_TYPE timeTagFormat;
       
TIME_TAG_TYPE timeTag;
       
TIME_TAG_TYPE referenceTimeTag;
} AR_TIMETAG_TYPE, *pAR_TIMETAG_TYPE;

Output

 

 

Name

Type

Description

timeString

char (passed by reference)

Pointer to resulting time string

References

Timer Functions
Alphabetical Function Index
Hierarchical Function Index

CEI-x30 API Description