aftp_get_date_mode_string

The aftp_get_date_mode_string call gets a string that corresponds to the input AFTP date mode value. This string is available to allow all users of the AFTP API to have consistent strings for each date mode type. It is not necessary to create an AFTP connection object before issuing this call.

AFTP_ENTRY aftp_get_date_mode_string(
IN AFTP_DATE_MODE_TYPE date_mode,
OUT unsigned char AFTP_PTR date_mode_string,
IN AFTP_LENGTH_TYPE date_mode_size,
OUT AFTP_LENGTH_TYPE AFTP_PTR returned_length,
OUT AFTP_RETURN_CODE_TYPE AFTP_PTR return_code
);

Parameters

date_mode

An AFTP date mode value.

AFTP_NEWDATE

Assign the time/date stamp of the time of transfer.

AFTP_OLDDATE

Assign the time/date stamp of the source file.

date_mode_string

The buffer into which the date mode string will be written.

Use the AFTP_DATE_MODE_SIZE constant to define the length of this buffer. Add 1 to the size if you want to be able to add a null terminator to the text in the buffer.

date_mode_size

The size of the buffer into which the date mode string will be written.

returned_length

The actual length of the date_mode_string parameter in bytes.

return_code

The return code issued for this function. See AFTP Return Codes for the list of possible return codes.

Example

{
    AFTP_RETURN_CODE_TYPE         aftp_rc;
    unsigned char                 date_mode[AFTP_DATE_MODE_SIZE+1];
    AFTP_LENGTH_TYPE              returned_length;

    /*
     * There are no prerequisite calls for this call.
     */

    /*
     * Get the date mode string.
     */

    aftp_get_date_mode_string(
        AFTP_OLDDATE,
        date_mode,
        (AFTP_LENGTH_TYPE)sizeof(date_mode)-1,
        &returned_length,
        &aftp_rc);
}
 

Line Flows

None.