Library.SetModuleCustomName Method

Sets a custom name for a module.

Namespace: IntervalZero.MaxRT.Ecat.Api.NetApi
Assembly: IntervalZero.MaxRT.Ecat (in IntervalZero.MaxRT.Ecat.dll) Version: 1.0.0.0 (File version: 1.0.1)

Syntax

Copy

public EcatErrorCode SetModuleCustomName(
    EcatHandle module,
    string name
)

Parameters

module

Type: EcatHandle
A handle to a module. To retrieve the corresponding handle, use OpenModuleByIndex or OpenModuleByLocation.

name

Type: String
A custom name for the module. The name does not need to be unique. The maximum length is 63.

Return Value

EcatErrorCode is thrown when any of these errors occur:

Error code	Meaning
ecatErrNoError	The function succeeded.
ecatErrNullParameter	Parameter name is null.
ecatErrWrongParameter	One of the following conditions occurred: Parameter module is invalid. The length of parameter name is greater than 63.
ecatErrMainDeviceNotReady	The MainDevice is not ready.
ecatErrWrongEnvironment	The MainDevice has not started.