SourceNameGet()

const char *const SourceNameGet

(

RSISource

source

)

Description:

SourceNameGet will return the first status bit which is set on an Axis or MultiAxis. The source can be checked when in an error state. There may be additional status bits set, use StatusBitGet to check any other bits.

Parameters

source

(RSISource)

Returns

(char*) The name of the RSISource.

Remarks

This function is also available in RapidSequencer.

Part of the State and Status method group.

Sample Code:

if (axis->StateGet() == RSIStateERROR)
 {
  int32_t source = axis->SourceGet();
  printf("Error source is %s\n", axis->SourceNameGet(source));
}

RapidSetup:

Go to Axis screen, Status tab.

This displays the various bit that are checked if axis is in error state

Note

See also

RSISource, StateGet

Examples

AxisStatus.cs.