IPen.GetInformation [Method]

Using the Process Analyst > Process Analyst for Developers > Automation Model > IPen.GetInformation [Method]

IPen.GetInformation [Method]

Returns information associated with this pen.

Defined As

[VBA] GetInformation(name As String) As String
[Cicode] STRING GetInformation(STRING name)
[C++] HRESULT GetDefaultSpan (BSTR name, BSTR* value)

Parameters

name

[in] Specify the pen information attribute you want to get the value for. See Remarks below for supported attributes.

value

[out] Indicates the value of the specified information attribute.

Execution Result

If the function succeeds, the return value will be Success. If an argument is bad, the return value will be InvalidArgument. If the attribute does not exist, the return value will be InvalidArgument. If the pen is deleted, the return value will be GeneralFailure. If any other unexpected error occurs, the return value will be GeneralFailure.

Information Attributes

Attribute	Returns	Applies to
Alarm Area	Alarm tag field	Alarm
Alarm Category	Alarm tag field	Alarm
Alarm Desc	Alarm tag field	Alarm
Alarm Name	Alarm tag field	Alarm
Alarm Type	Alarm tag field	Alarm
Comment	Alarm/Trend tag comment field	All
Duration	Process Analyst time span	All
End Time	Process Analyst axis end time	All
Engineering Full Scale	Trend tag field	Analog, Digital
Engineering Units	Trend tag field	Analog, Digital
Engineering Zero Scale	Trend tag field	Analog, Digital
Error	Process Analyst error status	All
Full Scale	Process Analyst vertical axis max scale	Analog,
Name	Process Analyst pen name	All
Raw Full Scale	Trend tag field	Analog, Digital
Raw Zero Scale	Trend tag field	Analog, Digital
Sample Period	Trend tag field	Analog, Digital
Start Time	Process Analyst axis start time	All
Tag	Process Analyst source binding field	All
Trend Type	Trend tag field	Analog, Digital
Zero Scale	Process Analyst vertical axis min scale	Analog
Scale	Process Analyst vertical axis scale range	Analog, Digital
Engineering Scale	Engineering scale range	Analog, Digita

Calling Syntax

Assumes you have passed a valid pen object into the function.

[VBA]

Sub Example(pen As Object)

 Dim duration As String

	duration = pen.GetInformation "Duration"

End Sub

[Cicode]

FUNCTION Example(OBJECT hPen)

	STRING duration;

  duration = _ObjectCallMethod(hPen, "GetInformation", "Duration");

END