aftp_extract_userid

The aftp_extract_userid call extracts the user identifier specified for the connection to the AFTP server. If the CPI-C Extract_Conversation_Security_User_ID function is not supported, the AFTP default user identifier value is returned.

AFTP_ENTRY aftp_extract_userid(
IN AFTP_HANDLE_TYPE connection_id,
OUT unsigned char AFTP_PTR userid,
IN AFTP_LENGTH_TYPE userid_size,
OUT AFTP_LENGTH_TYPE AFTP_PTR returned_length,
OUT AFTP_RETURN_CODE_TYPE AFTP_PTR return_code
);

Parameters

connection_id

An AFTP connection object originally created with aftp_create.

userid

The buffer into which the user identifier used on the connection will be written.

Use the AFTP_USERID_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.

userid_size

The size of the buffer into which the user identifier will be written.

returned_length

The actual length of the userid 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_HANDLE_TYPE              connection_id;
    AFTP_RETURN_CODE_TYPE         aftp_rc;
    unsigned char                 userid[AFTP_USERID_SIZE+1];
    AFTP_LENGTH_TYPE              returned_length;

    /*
     * Before issuing the example call, you must have:
     *    a connection_id, use:  aftp_create()
     */

    /*
     * Extract the user ID for AFTP.
     */

    aftp_extract_userid(
        connection_id,
        userid,
        (AFTP_LENGTH_TYPE)sizeof(userid)-1,
        &returned_length,
        &aftp_rc);
    if (aftp_rc != AFTP_RC_OK) {
        fprintf(stderr, "Error extracting userid.\n");
    }

}
 

Line Flows

None.