RtfwecatConfigureInstance

RtfwecatConfigureInstance configures an E-CAT MainDevice instance.

Syntax

Copy 
bool RtfwecatConfigureInstance(
    [in]    unsigned int Instance,
    [in]    RTFWECAT_INSTANCE_CONFIGURATION Configuration
);

Parameters

[in] Instance

The instance number to create, in the range 0-62.

[in] Configuration

The parameters for the instance to create.

Return Value

If the function succeeds, it returns TRUE. If the function fails, it returns FALSE. Call GetLastError to obtain an error code.

Possible error codes:

Error code Meaning

ERROR_INVALID_PARAMETER

One of the following conditions occurred:

  • The value of parameter Instance is outside the acceptable range (0-62).
  • Parameter Instance differs from Configuration.Instance.
  • Configuration.IdealProcessor does not correspond to the core assigned to the Subsystem.
  • Configuration.PrimaryNicName and Configuration.SecondaryNicName are the same.

ERROR_NOT_ENOUGH_MEMORY

Internal memory allocation failed.

ERROR_ALREADY_ASSIGNED

Configuration.IdealProcessor, Configuration.DisplayName, Configuration.PrimaryNicName, or Configuration.SecondaryNicName is used by another instance.

ERROR_NOT_FOUND

One of the following conditions occurred:

  • The instance does not exist.
  • Configuration.PrimaryNicName or Configuration.SecondaryNicName does not exist in the NL2 NIC list.

Requirements

Minimum supported version Header Library

wRTOS 1.0 SDK

RtfwecatApi.h

RtfwecatApi.lib

See Also: