NI DCPOWER Control Functions

Control Functions

• niDCPower_CommitWithChannels
• niDCPower_Commit
• niDCPower_InitiateWithChannels
• niDCPower_Initiate
• niDCPower_AbortWithChannels
• niDCPower_Abort

niDCPower_CommitWithChannels

ViStatus niDCPower_CommitWithChannels(ViSession vi);

Purpose

Applies previously configured settings to the specified channel(s). Calling this function moves the channel(s) from the Uncommitted state into the Committed state. After calling this function, modifying any attribute reverts the channel(s) to the Uncommitted state. Use the niDCPower_InitiateWithChannels function to transition to the Running state.

Related Topics:

Programming States

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies a particular instrument session. vi is obtained from the niDCPower_InitializeWithIndependentChannels function.
channelName	ViConstString	Specifies the channel(s) to use. Specify the channel(s) using the form PXI1Slot3/0,PXI1Slot3/2-3,PXI1Slot4/2-3 or PXI1Slot3/0,PXI1Slot3/2:3,PXI1Slot4/2:3, where PXI1Slot3 and PXI1Slot4 are instrument resource names and 0, 2, and 3 are channels. If you pass "" for this control, all channels in the session are used.

Return Value

Name	Type	Description
Status	ViStatus	Reports the status of this operation. To obtain a text description of the status code, call the niDCPower_error_message function. To obtain additional information concerning the error condition, call the niDCPower_GetError function.

niDCPower_Commit

ViStatus niDCPower_Commit(ViSession vi);

Purpose

This function is deprecated. Use niDCPower_CommitWithChannels instead.

Applies previously configured settings to the device. Calling this function moves the NI-DCPower session from the Uncommitted state into the Committed state. After calling this function, modifying any attribute reverts the NI-DCPower session to the Uncommitted state. Use the niDCPower_Initiate function to transition to the Running state. Refer to the Programming States topic in the NI DC Power Supplies and SMUs Help for details about the specific NI-DCPower software states.

Related Topics:

Programming States

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies a particular instrument session. vi is obtained from the niDCPower_InitializeWithIndependentChannels function.

Return Value

Name	Type	Description
Status	ViStatus	Reports the status of this operation. To obtain a text description of the status code, call the niDCPower_error_message function. To obtain additional information concerning the error condition, call the niDCPower_GetError function.

niDCPower_InitiateWithChannels

ViStatus niDCPower_InitiateWithChannels(ViSession vi);

Purpose

Starts generation or acquisition, causing the specified channel(s) to leave the Uncommitted state or Committed state and enter the Running state. To return to the Uncommitted state call the niDCPower_AbortWithChannels function.

Related Topics:

Programming States

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies a particular instrument session. vi is obtained from the niDCPower_InitializeWithIndependentChannels function.
channelName	ViConstString	Specifies the channel(s) to use. Specify the channel(s) using the form PXI1Slot3/0,PXI1Slot3/2-3,PXI1Slot4/2-3 or PXI1Slot3/0,PXI1Slot3/2:3,PXI1Slot4/2:3, where PXI1Slot3 and PXI1Slot4 are instrument resource names and 0, 2, and 3 are channels. If you pass "" for this control, all channels in the session are used.

Return Value

Name	Type	Description
Status	ViStatus	Reports the status of this operation. To obtain a text description of the status code, call the niDCPower_error_message function. To obtain additional information concerning the error condition, call the niDCPower_GetError function.

niDCPower_Initiate

ViStatus niDCPower_Initiate(ViSession vi);

Purpose

This function is deprecated. Use niDCPower_InitiateWithChannels instead.

Starts generation or acquisition, causing the NI-DCPower session to leave the Uncommitted state or Committed state and enter the Running state. To return to the Uncommitted state call the niDCPower_Abort function. Refer to the Programming States topic in the NI DC Power Supplies and SMUs Help for information about the specific NI-DCPower software states.

Related Topics:

Programming States

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies a particular instrument session. vi is obtained from the niDCPower_InitializeWithIndependentChannels function.

Return Value

Name	Type	Description
Status	ViStatus	Reports the status of this operation. To obtain a text description of the status code, call the niDCPower_error_message function. To obtain additional information concerning the error condition, call the niDCPower_GetError function.

niDCPower_AbortWithChannels

ViStatus niDCPower_AbortWithChannels(ViSession vi);

Purpose

Transitions the specified channel(s) from the Running state to the Uncommitted state. If a sequence is running, it is stopped.

Any configuration functions called after this function are not applied until the niDCPower_InitiateWithChannels function is called. If power output is enabled when you call this function, the output channel(s) remain in their current state and continue providing power.

Use the niDCPower_ConfigureOutputEnabled function or the niDCPower_ResetWithChannels function to disable power output on a per-channel basis.

Related Topics:

Programming States

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies a particular instrument session. vi is obtained from the niDCPower_InitializeWithIndependentChannels function.
channelName	ViConstString	Specifies the channel(s) to use. Specify the channel(s) using the form PXI1Slot3/0,PXI1Slot3/2-3,PXI1Slot4/2-3 or PXI1Slot3/0,PXI1Slot3/2:3,PXI1Slot4/2:3, where PXI1Slot3 and PXI1Slot4 are instrument resource names and 0, 2, and 3 are channels. If you pass "" for this control, all channels in the session are used.

Return Value

Name	Type	Description
Status	ViStatus	Reports the status of this operation. To obtain a text description of the status code, call the niDCPower_error_message function. To obtain additional information concerning the error condition, call the niDCPower_GetError function.

niDCPower_Abort

ViStatus niDCPower_Abort(ViSession vi);

Purpose

This function is deprecated. Use niDCPower_AbortWithChannels instead.

Transitions the NI-DCPower session from the Running state to the Uncommitted state. If a sequence is running, it is stopped. Any configuration functions called after this function are not applied until the niDCPower_Initiate function is called. If power output is enabled when you call the niDCPower_Abort function, the output channels remain in their current state and continue providing power.

Use the niDCPower_ConfigureOutputEnabled function to disable power output on a per channel basis. Use the niDCPower_reset function to disable output on all channels.

Refer to the Programming States topic in the NI DC Power Supplies and SMUs Help for information about the specific NI-DCPower software states.

Related Topics:

Programming States

Parameters

Input
Name	Type	Description
vi	ViSession	Identifies a particular instrument session. vi is obtained from the niDCPower_InitializeWithIndependentChannels function.

Return Value

Name	Type	Description
Status	ViStatus	Reports the status of this operation. To obtain a text description of the status code, call the niDCPower_error_message function. To obtain additional information concerning the error condition, call the niDCPower_GetError function.