Admin Production ni-theme
Current Publication

Get Output Phase Name

IVI Compliance Package

IviACPwr Get Output Phase Name VI

IviACPwrBase Capability Group

This VI returns the specific driver-defined output phase name that corresponds to the one-based index that the user specifies. If the driver defines a qualified output phase name, this VI returns the qualified name. If the value that the user passes for the Index input is less than one or greater than the value of the IviACPwr Output Phase Count property, the VI returns an empty string in the Name output and returns the Invalid Value error.

IviACPwr Get Output Phase Name

cio.gif instrument handle The instrument handle that you obtain from the IviACPwr Initialize or IviACPwr Initialize With Options VIs. The handle identifies a particular instrument session.

Default Value: None
ci32.gif Index (1) Specifies a one-based index that defines which name to return. Valid Range: 1 to the value returned by IviACPwr Output Phase Count property.

Default Value: 1
ci32.gif Name Buffer Size Specifies the number of bytes in the string that the user specifies for in the Name input.
cerrcodeclst.gif error in (no error) The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.
iio.gif instrument handle out The instrument handle that you obtain from the IviACPwr Initialize or IviACPwr Initialize With Options VIs.
istr.gif Name Specifies the buffer into which the VI returns the name that corresponds to the index the user specifies. The caller may pass VI_NULL (0) for this input if the value in the Name Buffer Size input is 0.
ierrcodeclst.gif error out The error out cluster passes error or warning information out of a VI to be used by other VIs.

The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.