COM - dpGetDescriptionLang()

Returns the description of a data point element in all available project languages.

Synopsis

HRESULT dpGetDescriptionLang([in] BSTR vDpName, [in, defaultvalue(-3)] int iMode, [out, retval]VARIANT *vDescription);

Parameter


Parameter	Description
vDpName	Data point element or data point
iMode	Mode for the operating mode
vDescription	The description of the data point element or data point

Description

This function returns the description of the given data point element in all available project languages.

If the value -3 (default) is used for the parameter iMode, the ComManager uses the default value from the config file. Otherwise mode is used as described in the ctrl function dpGetDescription().

EXAMPLE

(See ComSample.xls, CComSample)


`Public Sub dpGetDescriptionLang()Debug.Print moComManager.dpGetDescriptionLang("_mp_ANALOG2.analog.value")End Sub`

Assignment

COM