BSTR GetUserPreference (LPCTSTR Attribute);
Available (from release):
stOCX (V4-0), stPro Automation (V4-0)
Return Value:
The value of the requested Attribute if successful, otherwise an empty string.
Parameters:
|
Name: |
Description: |
|
Attribute |
The name of the User Preference that is to be fetched. |
Remarks:
Call this function to get a specific User Preference for the current User account.
Attribute information:
The following attributes can be fetched for the current User account.
|
Attribute Name: |
Attribute Value(s): |
Description: |
|
"ABBREVIATE TITLE" |
"YES" "NO" |
Gets whether Plot titles are being abbreviated. |
|
"ALL ON MAXIMIZE" |
"YES" "NO" |
Gets whether all the plot controls will be displayed when a plot is maximized. |
|
"ANNOTATIONS" |
"YES" "NO" |
Gets whether Annotations will be displayed on the Plot window. |
|
"AUDIT FLAGS" |
The active Flags ("A" - "Z") |
Gets the currently set Audit Flags. |
|
"AUDIT FILE" |
The name of the audit file. |
Gets the name of the current Audit File (including path). |
|
"AUDIT LEVEL" |
"1" "2" "3" "4" "5" |
Gets the current Audit level. |
|
"AUDIT MAX SIZE" |
A positive number (i.e. "1000") |
Gets the maximum size for each audit file (in kb). |
|
"AUDIT VERSIONS" |
A positive number (i.e. "1") |
Gets the number of audit file versions that are being kept. |
|
"AUTOROUND" |
"YES" "NO" |
Gets whether Auto rounding will be applied to all new pen scales by default. |
|
"AUTO SCALE STRATEGY" |
"FULL RANGE" "STDEV" |
Gets the algorithm used to scale pens in Auto scale mode. |
|
"BLINK LED" |
"YES" "NO" |
Gets whether the Plot Activity button blinks when new data is read. |
|
"BAD LINE" and "FILTER LINE" |
"None" "1 px" "2 px" "3 px" "4 px" "5 px" "Dotted" "Dashed" "Dash Dot" "Dash Dot Dot" |
Gets the line style used to display Bad data/Filtered values.
Note: Applies to Strip-Charts, Stacked Strip Charts and X-Y Line Plots only. |
|
"BAD SYMBOL" |
"Dot" "Circle" "Cross" "Plus" "Triangle Up" "Triangle Down" "Square" |
Gets the icon used to displaying bad data.
Note: Applies to X-Y Scatter Plots only. |
|
"DISPLAY SUFFIX" |
"YES" "NO" |
Gets whether the values in the item details area include suffix delimiters. |
|
"HIGHLIGHT XY" |
"YES" "NO" |
Gets whether new X-Y data values will be highlighted. |
|
"HGRID LINE" and "VGRID LINE" |
"1 px" "2 px" "3 px" "4 px" "5 px" "Dotted" "Dashed" "Dash Dot" "Dash Dot Dot" |
Gets the Horizontal/Vertical Grid line style. |
|
"IGNORE MISSING SAMPLES" |
"YES" "NO" |
Gets whether missing data will be included in averaging calculations. |
|
"ITEM WIDTH" |
A positive number specifying the width in MANUAL mode or "AUTO" - for Auto mode. |
Gets the width allowed for each pen on the Item details area. |
|
"LEFT TIME LABEL" |
"START TIME" "DURATION" |
Gets whether the left hand time label shows the start time for the plot, or the plot duration. |
|
"LINE INTERPOLATION" |
"STEP" "LINE" |
Gets whether you stPro is set to emulate a strip chart.. |
|
"LIVE PEN POINTERS" |
"YES" "NO" |
Get whether the Pen Pointers update at refresh rate regardless of zoom. |
|
"OPC ALIASES" |
"YES" "NO" |
Gets whether stPro will use OPC Item Aliases instead of Item names for the Pen Selection controls. |
|
"PEN POINTER SIZE" |
"1" = x1 "2" = x1.5 "3" = x2 "4" = x2.5 "5" = x3 |
Get the size of last value Pen Pointer. |
|
"PRINT FIT TO PAGE" |
"YES" "NO" |
Gets whether the plot printout will be stretched to make full use of the page. |
|
"PRINT MODE" |
"0" - Color "1" - Color (White Background) "2" - Black & White |
Gets the current printing mode. |
|
"PRINT TITLE" |
"YES" "NO" |
Gets whether the Plot Title is included when printing a hard copy of the plot. |
|
"PROPORTIONAL RESIZE" |
"YES" "NO" |
Gets whether stPro will maintain the relative size of each plot window with relation to the overall application window size. |
|
"RATIO IN TITLE" |
"YES" "NO" |
Gets whether the Compression Ratio is included in the Plot title. |
|
"RECALC SCALES" |
"YES" "NO" |
Gets whether Fit to View is applied for pens in Auto mode every time data is read. |
|
"ROLLOVER HILITE" |
"YES" "NO" |
Gets whether the highlight pens option is set. |
|
"ROUND INTERMEDIATES" |
"YES" "NO" |
Gets whether intermediate scales on the Y-axis are being rounded, or whether rounding just applies to the top and bottom scales. Note: Rounding Intermediates can result in significant changes being made to the scales to avoid duplicates and/or non linear scales being calculated. |
|
"SAVE PROMPT" |
"YES" "NO" |
Gets whether the user will be prompted to save changes when closing stPro. |
|
"SAVE SIZE" |
"YES" "NO" |
Gets whether the size and position of the stPro Application window are being saved in the Session file. |
|
"SAVE SELECTED PLOTS" |
"YES" "NO" |
Get whether Selected Plots are being saved within the Session file. |
|
"SCALE LINES" |
"2" "3" "4" "5" "6" "7" "8" "9" "10" |
Gets the number of Y-axis scale lines on the active plot. |
|
"SHOW TOOPTIPS" |
"YES" "NO" |
Gets whether the Item Details Area tooltips are active. |
|
"SLIDESHOW PAUSE" |
A positive number (i.e. "3") |
Gets the number of seconds to that stPro will Pause between plots when operating in Slide Show mode (in seconds). |
|
"SPLIT YAXIS ON DELIMITER" |
"YES" "NO" |
Gets the way that item names are broken up for the Y-axis labels |
|
"SYNCHRONIZE PLOTS" |
"YES" "NO" |
Gets whether time changes in the lead plot will be applied to all other plots. |
|
"SYNCHRONIZE CURSORS" |
"YES" "NO" |
Gets whether the plot cursor acts across all the plots within the Session. |
|
"TIME OFFSET" |
"MANUAL",offset or "PC", offset |
Gets the offset from UTC that is being applied to Time stamps
Note: A value of "PC" indicates that stPro is tracking the PC's offset from UTC, which 'offset' showing the resulting time offset. Tip: Fields that contain a delimiter are displayed using the default Field delimiter of ','. If SetDelimiter has been used, then the user should substitute the ',' for the user specified delimiter. |
|
"TOOLBAR SIZE" |
"1" "2" "3" "4" "5" |
Gets the current size of the stPro Toolbars. |
|
"TRUE POSITIVE" |
"YES" "NO" |
Gets whether Boolean values of -1 will be displayed as +1. |
|
"YAXIS COLOUR" |
"YES" "NO" |
Gets whether the Y-axis labels will be displayed using the associated Pen Color.
Note: The attribute was deprecated in release V5-0. Use the "YAXIS MODE" attribute instead. |
|
"YAXIS MODE" |
"FOREGROUND" "PEN COLOR" "CURRENT VALUE" "NO LABELS" |
Gets the color that used for the Y-axis labels or whether the central axis tick mark displays the current value of the item . |
|
YAXIS WIDTH |
"MANUAL,m,n" or "AUTO" - for Automatic. |
Gets the number of characters being used for Y-axes (m) and the required pixel adjustment (n) if any.
Tip: Fields that contain a delimiter are displayed using the default Field delimiter of ','. If SetDelimiter has been used, then the user should substitute the ',' for the user specified delimiter. |
Note: Attributes are NOT case sensitive.