COM - dpGetDescription()
Returns the description of a datapoint element.
Synopsis
HRESULT dpGetDescription([in] VARIANT vDpName, [in, defaultvalue(-3)] int iMode, [out, retval]VARIANT *vDescription);
Parameter
| Parameter | Description |
|---|---|
| vDpName | Datapoint element or datapoint |
| iMode | Mode for the operating mode |
| vDescription | The description of the datapoint element or datapoint |
Description
In contrast to the CTRL function of the same name, no langStrings are supported, as there are no corresponding variable types in the COM object model. The parameter vDpNames supports both a single string and an array of strings. The result depends on what is used.
If the value -3 (default) is used for the iMode parameter, the ComManager uses the default value from the config file. Otherwise, the mode is used as described in the CTRL function dpGetDescription()
EXAMPLE
(See ComSample.xls, CComSample)
Public Sub dpGetDescription()
Debug.Print moComManager.dpGetDescription("_mp_ANALOG2.analog.value")
End Sub