NI-Digital Pattern Driver C Function Reference

niDigital_GetChannelNameFromString

  • Updated2023-11-24
  • 1 minute(s) read

niDigital_GetChannelNameFromString

Low Level Group

Returns a comma-separated list of channel names from a string index list.

C Function Prototype: ViStatus niDigital_GetChannelNameFromString (ViSession vi, ViConstString index, ViInt32 nameBufferSize, ViChar name[] )

Parameter Description
vi The specified instrument session the niDigital_init or niDigital_InitWithOptions function returns.
index Index list for the channels in the session. Valid values are from zero to the total number of channels in the session minus one. The index string can be one of the following formats:
  • A comma-separated list—for example, "0,2,3,1"
  • A range using a hyphen—for example, "0-3"
  • A range using a colon—for example, "0:3 "
You can combine comma-separated lists and ranges that use a hyphen or colon. Both out-of-order and repeated indices are supported ("2,3,0," "1,2,2,3"). White space characters, including spaces, tabs, feeds, and carriage returns, are allowed between characters. Ranges can be incrementing or decrementing.
nameBufferSize The number of elements in the ViChar array you specify for name.
name The returned channel name(s) at the specified index.

Return value: Reports the status of the operation. If the buffer size is 0 or too small for the error description, the buffer size needed for the full description is returned.

Log in to get a better experience