Set method

Description

VWorks software calls the Set method to tell the plugin to command the specified digital output channel on the device to output the specified voltage.

Syntax

 

HRESULT Set( [in] BSTR xml, [out,retval] enum ReturnCode *retVal );

Parameters

 

xml	[in] A digitalOutput XML element that contains the name of a digital output channel on a device and the voltage to set.
retVal	[out, retval] Returns an error code. Possible values: 0 = The request was completed (RETURN_SUCCESS) 1 = Something was wrong with the input, so the request was not completed (RETURN_BAD_ARGS) 2 = The request was not completed (RETURN_FAIL) For more information, see “ReturnCode enumerated type” .

Set method input

VWorks software passes a digitalOutput XML element into the xml parameter of the Set method.

The value of the file attribute of the Velocity11 element is Velocity11. See “Velocity11 element” .

digitalOutput element

The digitalOutput element has the following attributes:

 

Name	Value
name	The name of the output channel.
value	The output signal (voltage) to set.

Example of Set method input

The following sample code contains a digitalOutput XML element that is received by the plugin from VWorks software as a string in the xml parameter of the Set method. VWorks software tells the plugin to command the digital output channel named Output channel to output 100 volts.

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='Velocity11' md5sum='bfea461a5f6cf84f987ede1376b68cdf' →version='1.1' > <digitalOutput name='Output channel' value='100' /> </Velocity11>

Related information

 

For information about...	See...
EnumPoints method	“EnumPoints method”
Read method	“Read method”