nctStart

NI-CAN

nctStart

Purpose

Starts communication for the specified task.

Format

nctTypeStatus nctStart(
nctTypeTaskRef TaskRef);

Inputs

TaskRef

Task reference from the previous NI-CAN function. The task reference is originally returned from functions such as nctInitialize or nctCreateMessage.

Outputs

Return Value

The return value indicates the status of the function call as a signed 32-bit integer. Zero means the function executed successfully. A negative value specifies an error, which means the function did not perform the expected behavior. A positive value specifies a warning, which means the function performed as expected, but a condition arose that may require attention.

Use the ncStatusToString function of the Frame API to obtain a descriptive string for the return value. The ncStatusToString and ncGetHardwareInfo functions are the only Frame API functions that can be called within a Channel API application.

Description

You must start communication for a task to use nctRead or nctWrite. After you start communication, you can no longer change the configuration of the task with nctSetProperty or nctConnectTerminals.