user_open_port

Opens the port for communications.

You can find the template for this subroutine in:

usrtm_opport.c

Syntax

void user_open_port(char *port_id,
                    int *baud_rate,
                    int *parity,
                    int *status)

Input Parameters

port_id

Is a pointer to a character string containing port used for communications.

The name provided is in upper-case characters and identifies the port name on the computer.

baud_rate

Is the pointer to the baud rate selected for the given port_id .

parity

Is the pointer to the parity selected for the given port_id .

Valid values for serial ports are:

  • TOOLKIT_NO_PARITY
  • TOOLKIT_EVEN_PARITY
  • TOOLKIT_ODD_PARITY

Output Parameters

status

Indicates whether the function completed successfully. Valid values are:

TOOLKIT_SUCCESS Function completed successfully.
TOOLKIT_FAILURE Function did not complete successfully.

Return Value

None.