BSTR GetPens(long AttributeMask);
Availability:
stOCX (V2-00), stPro Automation (V2-01)
Return Value:
A delimited string containing the list of pens and pen attributes.
The details for each pen will be separated by the Record delimiter (defaulted to a '|'). Each attribute for a given pen will be separated by the Field delimiter (defaulted to a ',').
Note: The default Record and Field delimiters can be overridden by calling SetDelimiter.
Parameters:
|
Name: |
Description: |
|
AttributeMask |
Indicates what information is required to be returned for each pen.
This parameter is a bit mask and can be any combination of:
|
Remarks:
Call this function to return information about each of the pens defined on the graph.
Note: The information is returned as a single string with each pen being delimited by a ‘|’ and each attribute delimited by a ‘,’.
Tip: If multiple attributes are requested for a pen then they are returned in ascending attribute order.
Example:
Assuming the plot contains the following pens:
|
Handle: |
DL: |
Item Name: |
|
1000 |
__PERF__ |
math.seconds |
|
3000 |
__PERF__ |
math.hours |
|
2000 |
__PERF__ |
math.minutes |
Then a request for the handle and the item name of all the pens displayed on the graph would be:
Dim PenList As String
PenList = GetPens(5)
PenList would then contain the following string:
1000,math.seconds|3000,math.hours|2000,math.minutes