DeltaV-specific VBA functions

( )

Opens the User Settings dialog.

( _

Entry as String, _

Optional EntryEnabled As Boolean = True)

As Long

Sequentially adds an entry to the menu. Returns the error code from the AddMenuEntry popupmenuclass method.

Entry - The string to be added to the menu.

EntryEnabled - set to True to enable new menu entry.

( ) As Long

Adds a separator to the next position in the menu. Returns error code from the AddSeperatorEntry popupmenuclass method.

( _

strParampath As String, _

Optional strServer As String, _

Optional strNode As String, _

Optional strMod As String, _

Optional strFB1 As String, _

Optional strFB2 As String, _

Optional strFB3 As String, _

Optional strParam As String, _

Optional strField As String, _

Optional strExpression As String, _

Optional strZone As String) _

As Boolean

Converts the components of the path into a full path.

strParampath - The full parameter path.

strServer - The server of the path.

strNode - The node in the parameter path.

strMod - The module in the parameter path.

strFB1 - The function block in the parameter path.

strFB2- The function block in the parameter path.

strFB3 - The function block in the parameter path.

strParam - The parameter in the parameter path.

strField - The field in the parameter path.

strExpressions - Anything after the field (for an expressions).

strZone - The zone name in the parameter path.

(blnExpression As Boolean,

Optional strMessage As String)

Allows the operator to go to debug mode when an error occurs.

blnExpression - Set to False to enter debug mode.

strMessage - Error message displayed on the assert dialog.

( _

ConfirmRequired as Boolean, _

Optional Caption as string = " ")

As Boolean

Displays the Data Entry Expert confirmation dialog (which is actually a form that allows the Data Entry Expert to timeout gracefully).

ConfirmRequired - When True, confirmation is required.

Optional Caption - The string displayed on the dialog.

( _

oObj as object, _

sEventName as String, _

lEventIndex as Long)

As Boolean

Checks for the event handler (sEventName) on the object (oObj) and returns True if found; otherwise, returns False. The event index is returned if the event is found.

oObj - The object being checked.

sEventName - The event handler on the object being checked.

lEventIndex - The event index that is returned if the event is found.

(strPic as String) As Boolean

Checks if the picture passed in is a main picture, toolbar, or alarm banner picture.

strPic - The picture name.

(nmaf As String) As Boolean

Checks to see if a parameter is configured on a module by performing a ReadValue of the attribute. Nmaf must be a syntactically correct tag and module should exist.

nmaf - The node module attribute field.

(NN As String) As Boolean

Checks if the passed in nickname is one of the nicknames of either Toolbar/2, Mainpicture/2, alarmban, or alarmbn2. Returns True if nickname matches one of the above names.

NN - The nickname being checked.

( ) As Long

Checks the active picture for the following:

Excessive datalinks with animations

Datalinks with incorrect display formatting

Empty groups

Results are reported to the user and the user is given the option of viewing (in Notepad) the list of datalinks that match one of the above considerations.

( ) As Boolean

Searches the list of open forms looking for the "frmDataEntryConfirmation" form and closes it if found. If found and closed, returns True; otherwise, returns False.

( )

Used by the Close File button on the tool bar to close the current file.

(Optional picName As String)

Closes a picture. Will close a main picture.

picName - Name of picture to close. If empty, the current picture is closed. You can use an alias instead of picture name.

( ) As Long

Creates a popup menu. Uses the Popup Menu Class. The handle to the menu is returned and should be passed to all subsequent calls. Returns the error code from the OpenPopupMenu popupmenuclass method.

( _

strParampath As String,

Optional strServer As String, _

Optional strNode As String, _

Optional strMod As String, _

Optional strFB1 As String, _

Optional strFB2 As String, _

Optional strFB3 As String, _

Optional strParam As String, _

Optional strField As String, _

Optional strScale As String, _

Optional blnFB As Boolean, _

Optional bAllowTG As Boolean, _

Optional strZone As String)

As Boolean

Disassembles paths with Server.Node.Tag.Field[scale].

strParampath - The full parameter path.

strServer - The server of the path. If a server is not given in the input string, it will return the default server.

strNode - The node in the parameter path.

strMod - The module in the parameter path.

strFB1 - The function block in the parameter path.

strFB2- The function block in the parameter path.

strFB3 - The function block in the parameter path.

strParam - The parameter in the parameter path.

strField - The field in the parameter path.

strScale - The special scaling parameter field in the parameter path.

blnFB - The Boolean that, if True, requires the final entry in string to be a function block name.

bAllowTG - When True, a tag group name is used in the parameter path.

strZone - The zone name in the parameter path.

( _

strInString As String, _

Optional strServer As String, _

Optional strNode As String, _

Optional strMod As String, _

Optional strFB1 As String, _

Optional strFB2 As String, _

Optional strFB3 As String, _

Optional strParam As String, _

Optional strField As String, _

Optional strScale As String, _

Optional strExpression As String,

Optional bAllowTG As Boolean, _

Optional strZone As String)

As Boolean

Disassembles any function block path.

strInString - The input function block path.

strServer - The server of the path. If a server is not given in the input string, it will return the default server.

strNode - The node in the parameter path.

strMod - The module in the parameter path.

strFB1 - The function block in the parameter path.

strFB2- The function block in the parameter path.

strFB3 - The function block in the parameter path.

strParam - The parameter in the parameter path.

strField - The field in the parameter path.

strScale - The special scaling parameter field in the parameter path.

strExpression - Anything after the scale (for an expressions).

bAllowTG - When True, a tag group name is used in the parameter path.

strZone - The zone name in the parameter path.

( _

sPN As String, _

Optional path As String = "")

As Boolean

Checks to see if the picture exists. If exists, returns the full path.

sPN - The name of the picture searching for.

path - the path to the picture. Defaults to the system.picturepath directory if blank.

( )

Calls the Build Dynamo Expert. Use the Build Dynamo button on the tool bar.

( )

Displays a dialog to confirm the operator wants to exit DeltaV Operate.

(picName As String)

Called by the frsClosePic subroutine. Closes a picture based on the picName, alias, or find the current open picture. Will not close the main picture.

picName - The picture name or alias that you want to close. If no file name is specified, the current picture closes.

( _

FileToFind As String, _

RootDir As String, _

Optional CheckSubFolder As Boolean = True, _

Optional FullFileName As Variant)

As Boolean

Searches from the location specified in RootDir. Searches all subfolders for the file specified in FileToFind if CheckSubFolder is True. Returns the full path to that file (if found).

FileToFind - The filename searching for.

RootDir - The starting directory (root) for the search.

CheckSubFolder - The command to check the subfolders (of the directory specified in RootDir). Defaults to True.

FullFileName - The result of the search with the full path and filename.

(startObject As Object,

PartialName As String) As Object

Finds a contained object. Returns nothing if the object is not found.

startObject - The object in which to start searching.

PartialName - A partial (or full) name of the object to be found.

(objpicture As Object) As String

Returns the alias or nickname of a picture.

Return - The alias or nickname of the picture.

objpicture - Picture object.

(objPicture As Object) As String

Returns the caption of the object. Returns an empty string on any error.

objPicture - The page object to get the caption.

( ) As String

Returns the computer name. Returns an empty string on any error.

( ) As String

Reads the Windows Registry key to find the installed DeltaV folder.

(strFileSpec As String,

strBasePath As String) As String

Determines if fileSpec is in a path relative to the pic directory or in the base path. If fileSpec contains a '\' it is relative to the pic directory; otherwise, it is in the base path. The existence of the file will not be tested.

strFileSpec - The name of the file.

strBasePath - The base path.

(picName As String) As Long

Returns what monitor the picture is on.

picName - The name of the picture for which you are checking monitors. If no file name is specified, the current picture checked.

(PicObj As Object) As Long

Returns what monitor the object is on.

PicObj - The object name for which you are checking monitors.

( ) As Long

Returns the monitor number of the picture that is active.

(pic As Object) As Boolean

Returns the picture object in Pic. Returns True if picture is found; otherwise, returns False if picture is not found or there is an error.

pic - Picture to get.

( )

The FRSI error handler.

(objObject As Object,

strProperty As String) As Boolean

Determines if an object contains a specific property. Returns True if property is found; otherwise, returns False.

objObject - Object to search.

strProperty - The name of property for which it is looking.

(strName As String,

lngXCoor As Long,

lngYCoor As Long,

blnBottomPinned As Boolean,

blnRightPinned As Boolean)

Used by the Popup Positioning Control in the frsPopups dynamo set. Retains the last position of the window, provided the window was closed using frsClosePic.

strName - The name of the window.

lngXCoor - The X coordinate to use for the window's initial position.

lngYCoor - The Y coordinate to use for the window's initial position.

blnBottomPinned - Sets whether the bottom of the window is pinned.

blnRightPinned - Sets whether the right side of the window is pinned.

( _

objPic As Object, _

Optional strModPassed As String = " ", _

Optional lngMonOverride As Long = 0, _

Optional blnDoNotAsk As Boolean = False, _

Optional strServerHint As String = "")

Opens the module's detail display picture from any supported server.

objPic - The object picture name.

strModPassed - The module name.

lngMonOverride - The monitor number. If entered, overrides the current monitor action.

blnDoNotAsk - The command to not prompt for any questions. When True, no questions are asked and the routine ends if it cannot complete. The default is False.

strServerHint - The server name, if known. 

( _

objPic As Object, _

Optional strModPassed As String, _

Optional blnDoNotAsk As Boolean = False, _

Optional strServerHint As String = "")

Opens the module's faceplate from any supported server.

objPic - The object picture name.

strModPassed - The module name.

blnDoNotAsk - The command to not prompt for any questions. When True, no questions are asked and the routine ends if it cannot complete. The default is False.

strServerHint - the server name, if known.

( _

objPic As Object, _

Optional strModPassed As String = "", _

Optional lngMonOverride As Long = 0, _

Optional blnDoNotAks As Boolean = False, _

Optional strServerHint As String = "")

Opens the module's primary display from any supported server.

objPic - The object picture name.

strModPassed - The module name.

lngMonOverride - The monitor number. If entered, overrides the current monitor action.

blnDoNotAsk - The command to not prompt for any questions. When True, no questions are asked and the routine ends if it cannot complete. The default is False.

strServerHint - the server name, if known.

( )

Displays an error dialog stating that the operator does not have privilege to perform the operation requested.

(Line As String) As Boolean

Checks if the line is a comment line. True is a comment. False is not a comment.

Line - The line being checked.

(sCh As String) As Boolean

Checks if string is an alphabetic (not numeric) string. Not case sensitive. Returns True if string is alphabetic; otherwise, returns False if string is not alphabetic.

sCh - The character string being checked.

( ) As Boolean

Returns True if it is a multiple monitor system.

(oPic As Object) As Boolean

Returns True if the picture has multiple copies. That is, if there are copies of the picture in the Temp folder.

oPic - The object picture name.

(PN As String) As Boolean

Searches the list of documents open on the system and returns True if a match is found; otherwise, returns False.

PN - The picture name.

(PicObj As Object) As Boolean

Returns True if the picture is locked; otherwise, returns False. Used on popups, for example, faceplates.

PicObj - The object name for which you are checking the pinned state.

(objDynamo)

This subroutine is specifically designed for the Lab Entry function block.

(strNM As String,

lngDoMonitor As Long)

Opens a detail picture for a module.

strNM - The module for which the detail display will open using the format server.node.module.

lngDoMonitor - This is the monitor on which to open the detail display.

(strNM As String,

Optional lngDoMonitor As Long)

Displays a faceplate for a module.

strNM - The module for which the faceplate will open using the format node.module.

lngDoMonitor - The monitor to open the faceplate on. Defaults to Monitor 1.

(strNMB As String,

strPic As String,

lngDoMonitor As Long)

Opens a detail display for a function block detail picture when given the block in the format server.node.module\functionblock and a monitor. Requires the full picture path or defaults to the Pic folder. The path must be in UNC (\\nodename\folder\file).

strPic - The full path to the detail picture name for the function block.

strNMB - This is the server.node.module\functionblock to open.

lngDoMonitor - This is the monitor to open the detail on.

(strPic As String,

strNMB As String,

lngDoMonitor As Long)

Opens a function block faceplate for a function block when given the block in the format server.node.module\functionblock and a monitor. Requires the full faceplate picture path or defaults to the Pic folder. The path must be in UNC (\\nodename\folder\file).

Use the Open Faceplate Expert instead.

strPic - The full path to the faceplate picture name for the function block.

strNMB - A string with the server.node.module.

lngDoMonitor - The monitor to open the faceplate on. Defaults to Monitor 1.

(strNMB As String,

strPic As String,

lngDoMonitor As Long)

Opens a function block trend picture when given the block in the format server.node.module and a monitor. Requires the full trend path or defaults to the Pic folder. The path must be in UNC (\\nodename\folder\file).

strNMB - This is the server.node.module to open.

strPic - The full path to the trend picture name for the function block without the "_trn".

lngDoMonitor - This is the monitor to open the trend on.

(strNM As String,

lngDoMonitor As Long)

Opens the primary control display for a module. Use the format node.module and specify a monitor.

strNM - This is the node.module to open.

lngDoMonitor - This is the monitor to open the main display on.

(objpicture As Object,

symbol As Variant,

replacement As Variant)

Performs a temporary (for this opening only), dynamic (as it opens) substitution on a picture that is open.

objpicture - The picture object on which the substitution is being done.

Symbol - The symbol ARRAY in the picture that the substitution will be performed on. This must be an array of the same size as the replacement.

Replacement - The string ARRAY that will be inserted in for the symbol. This must be an array of the same size as the symbol.

(strPictureName As String, symbol, replacement)

Performs a temporary (for this opening only), dynamic (as it opens) substitution on a picture that is open. If the picture is not open substitution is not performed. Replaces the need to use frsLoadTGDPictureDynamic where the substitution is done by picture object.

strPictureName - The picture name on which the substitution is being done.

Symbol - The symbol ARRAY in the picture that the substitution will be performed on. This must be an array of the same size as the replacement.

Replacement - The string ARRAY that will be inserted in for the symbol. This must be an array of the same size as the symbol.

(strNM As String,

lngDoMonitor As Long)

Use this function to open a real-time trend display for a module. Use the format node.module and specify a monitor.

strNM - The module for which the trend will open using the format node.module.

lngDoMonitor - The monitor on which to open the trend.

(sngLength As Double,

objpicture As Object) As Double

Converts the length of the picture or object's logical units into himetrics.

sngLength - The length to convert in picture Logical units.

objpicture - The picture that contains the control that needs the length converted to himetrics.

(ByVal Prompt As String,

Optional Buttons As VbMsgBoxStyle = vbOKOnly,

Optional Title As String = "DeltaV Operate",

Optional HelpFile As String = "",

Optional Context As Long = 0) As VbMsgBoxResult

Creates a message box (dialog) that is repositioned at the cursor. The interface and behavior is the same as MsgBox.

Prompt - The text displayed on the message box.

Buttons - Defaults to the OK button only. Can be overridden to show any of the other MsgBox buttons.

Title - The text in the title bar of the message box.

HelpFile - The name of the help file to call when the Help button is clicked.

Context - This is the context index for the help file.

ByVal Prompt As String,

ByVal ButtonCaptions as String,

ByVal ButtonRetVal,

Options As VbMsgBoxStyle = vbOKOnly,

Title As String = "DeltaV Operate") As VbMsgBoxResult

Behaves in a manner similar to frsMsgBox but the buttons and return values can be customized by the user. A maximum of four (4) buttons can be displayed.

Prompt - The text displayed on the message box.

ButtonCaptions - Variant array of strings displayed on the buttons. One-to-one correspondence to ButtonRetVal.

ButtonRetVal - Variant array of numeric values that are returned when the button is pressed. vbCancel can also be returned from the "X" on the title bar.

Options - Determines the default button (when the ENTER key on the keyboard is pressed) and which image will be displayed. Can be omitted from the call in which case no image is displayed.

Title - The text in the title bar of the message box.

( )

Opens the dialog to create a new picture from a template.

(ObjectName As String,

Optional baseObject As Object,

Optional returnObject As Object) As Boolean

Searches for the name of an object in either the current open picture or a baseObject (if specified). It returns the handle to the object if found and nothing if not found.

ObjectName - This is the name of the object for which it is looking.

baseObject - The object to look in for the ObjectName. If left blank, this function will look for an open picture.

returnObject - Returns the handle to the object if found and nothing if not found.

(Optional strArea As String,

Optional lngMonitor As Long)

Use this subroutine to open the alarm list by area. It is recommended that instead of writing this code, you use the Alarm List button and set the area.

strArea - Name of the alarm area or if empty (default) all alarm areas will be displayed.

lngMonitor - The monitor to open the picture on. Defaults to 1.

(Optional strArea As String,

Optional lngMonitor As Long)

Use this subroutine to open the alarm suppress list by area. It is recommended that instead of writing this code, you use the Alarm Suppress List button and set the area.

strArea - Name of the alarm area or if empty (default) all alarm areas will be displayed.

lngMonitor - The monitor to open the picture on. Defaults to 1.

(picture As String,

Optional PictureAlias As String,

Optional lngTopPosition As Long,

Optional lngLeftPosition As Long,

Optional picCaption as String)

The typical use of this subroutine is to click on an object and display a picture. Configure this usage with the DeltaV Operate Expert.

picture - The file name of the picture to open.

PictureAlias - Alias or nickname to assign to the picture.

lngTopPosition - The position to place the top of the picture.

lngLeftPosition - The position to place the left side of the picture.

picCaption - The caption to display in the title bar of the picture being opened.

(strScheduleName As String,

Optional strSchedulePath As String)

Opens a schedule.

strScheduleName - The name of the schedule to open.

strSchedulePath - The path to open the schedule from, when not in the default path of c:\DeltaV\DvData\Graphics-iFix\pdb\.

(picture As String,

symbol As Variant,

replacement As Variant,

Optional Y As Single,

Optional X As Single,

Optional caption As String,

Optional nickname As String) As Object

Opens a picture and performs a temporary (for this opening only), dynamic (as it opens) substitution on the picture.

Picture - Name of the picture to open.

Symbol - The symbol ARRAY in the picture that the substitution will be performed on. This must be an array of the same size as the replacement.

Replacement - The string ARRAY that will be inserted in for the symbol. This must be an array of the same size as the symbol.

Y - The top coordinates of the picture in pixels.

X - The left coordinates of the picture in pixels.

caption - The caption to display on the title bar of the picture being opened.

nickname - The nickname being assigned to the picture being opened.

( )

Replaces the current picture with the UnacknowledgedPrompts picture.

(sPicName As String) As Boolean

Validates the passed in picture name against valid naming conventions as follows:

The first character must be alpha

Remaining characters can be alpha, numeric, or '_'

The filename must not exceed 31

The GRF extension is optional.

sPicName - The picture name being validated.

(lngMonitor As Long)

Prints a picture on the windows default printer. Use the Print button on the main template for this function.

lngMonitor - Monitor displaying picture to print.

( )

Opens the multiple property form. Used in configuration only.

(DataPoint As String,

Optional lngErrNumber As Long,

Optional strErrDescription As String,

Optional blnShowErrorDialog As Boolean)

Reads a database value, such as setpoint or mode.

DataPoint - Tag to be read.

lngErrNumber - Status of read. 0 if read was successful. Returns the error number if read is not successful.

strErrDescription - Error string. Empty if successful.

blnShowErrorDialog - Show an error dialog. True (default) - post an error dialog when an error is encountered. False - do not post an error dialog if an error is encountered.

( )

Ungroups an object. If nothing is selected on the picture, all groups on the picture are ungrouped.

( )

Changes the index of multiple groups.

( )

Opens the dialog that allows you to change the size of a picture. The preferred method is to use the Resize Picture button.

(Optional Start As Long,

Optional String1 As String,

Optional String2 As String,

Optional Compare As Long) As Long

This function will return the position of the last instance of String2 found in String1.

Start - Sets the starting position for each search using the character position in the string.

String1 - String being searched.

String2 - String expression sought.

Compare - Specify 0 (default) to perform a binary comparison. Specify 1 to perform a textual comparison that is not case sensitive. For Microsoft Access only, specify 2 to perform a comparison based on information contained in your database.

(strExecutable As String,

Optional strParameters As String,

Optional blnErrorFlag As Boolean) As Double

To launch an application from DeltaV Operate

strExecutable - Name of the executable to run.

strParameters - Command line input parameters for the executable.

blnErrorFlag - Enables/disables error reporting. Defaults to True (enabled).

( )

Called by the Save button on the tool bar.

(objpicture As Object,

PictureAlias As String) As String

Set the alias or nickname of a picture.

objpicture - Picture object.

PictureAlias - Alias or nickname to assign to the picture.

(objpicture As Object,

strCaption As String) As Boolean

Set the caption of a picture.

objpicture - Picture object.

strCaption - New caption.

(NewITO As Long)

Sets a new input timeout, overriding the existing input timeout. Unit is in seconds.

NewITO - The new input timeout value. Default is 30 seconds.

( _

TB As TextBox, _

EnableFlag As Boolean)

As Boolean

Enables or disables a text box. Returns True if the text box enable/disable state is set; otherwise, returns False.

TB - The text box being enabled or disabled.

EnableFlag - The Boolean flag that is set to enable or disable the text box.

( ) As Long

Displays the menu. This function will not return until the left mouse button is clicked (whether or not the cursor is over the menu). Returns the sequence number for the menu item selected.

(fileName As String)

Plays a sound. Specify the complete path; otherwise, defaults to the PIC directory. cannot use UND (\\nodename\folder\file) format in the sound file path. Must use a valid drive letter path (D:\folder\file).

fileName - Filename of the sound file.

( )

Creates an instance of the trace class and opens the tracebox

if trace has been enabled.

(PauseTime As Long)

Caution For internal use only. Not recommended for all customers. Suspending a VBA thread suspends ALL processes since VBA is single-threaded.

(msg As String,

Optional Severity As String,

Optional Project As String, Optional Id As String)

Adds a user defined message to the trace class.

( ) As Boolean

Checks if the currently logged-in user has configuration privileges. Returns True if the user can configure; otherwise, returns False.

(PBName As String) As Boolean

Validates a DeltaV named set item against current valid naming conventions as follows:

the name's maximum length = 48

the name has at least one Alpha character

the name is Alphanumeric

the name can contain the additional characters of "$", "_", "-", "?", "/", " " (space)

PBName - The name of the named set entry.

( _

sPicName As String, _

Optional PicPath As String = "")

As Boolean

Validates if the picture's name syntax is correct (as defined by frsPictureNameOK and if True, checks if the picture exists.

sPicName - The picture name to be validated.

PicPath - The path to the picture.

(sInput As String) As Boolean

Validates a tag on a picture. Checks that the characters are the following:

A-Z

a-z

$

a number

an underscore.

a dash

sInput - The input (tag) to be validated.

(Value As String,

DataPoint As String,

Optional lngErrNumber As Long,

Optional strErrDescription As String,

Optional blnShowErrorDialog As Boolean)

Writes to a module parameter such as setpoint or mode

Value - Data to be written.

DataPoint - Tag to be written to.

lngErrNumber - Status of read. 0 if write was successful.

strErrDescription - Error string. Empty if successful.

blnShowErrorDialog - Show an error dialog. True (default) - post an error dialog when an error is encountered. False - do not post an error dialog if an error is encountered.

As String

Returns the DeltaV detail function block path. Equivalent to system.picturepath & "\DetailFB\".

As String

Returns the DeltaV detail path. Equivalent to system.picturepath & "\Detail\".

(oPic As Object)

Closes the popup picture referenced retaining the picture's position on the screen.

oPic - Object reference to the picture.

(ByVal Scr As DV_SCREENS) As Long

Returns the monitor number as configured by the video driver (1, 2, 3, 4) for the DeltaV screen name (Primary, Secondary, USER1 and USER2) given.

Scr - The DeltaV screen name to be converted.

(ByVal MonNum As Long) As DV_SCREENS

Returns the enumeration of the DeltaV screen name for the monitor number (1, 2, 3, 4) given.

MonNum - The number of the monitor to convert.

(

Optional Screen As DV_SCREENS) As String

Returns the current main picture name.

Screen - Enumeration of the screen. If Screen is not specified, the name of the default screen number is used.

(ByVal errNumber as Long,

Optional ExtendedError As Long) As String

Returns the error string for the error number given.

errNumber - The number of the error message to be looked up.

ExtendedError - The number of the extended error message.

(ByVal Feature As DV_IFIX_REVISION) As String

Returns the revision information string for the selected feature.

Feature - Enumeration of the feature revision data.

(InputVal As Long) As Boolean

Checks if the passed in value is greater than the current input timeout value. True is InputVal is greater that the default timeout value.

InputVal - Typically, this is a counter value that is periodically incremented. If input timeout is disabled, this parameter is set to 0.

(ByVal Screen As DV_SCREENS,

ByVal PicType As DV_PICTURES,

Optional Xpos As Long,

Optional Ypos As Long

Optional NN As String) As Boolean

Opens a predefined DeltaV picture on the desired screen. Coordinates are relative to the upper left corner of the screen. If coordinates are not provided, standard DeltaV defaults are used. Returns True if PicType and Screen are valid. Picture might not open for other reasons that are not indicated in the status.

Screen - Enumeration of screen on which to open the picture.

PicType - Enumeration of picture to open.

Xpos - Horizontal position of the picture in pixels.

Ypos - Vertical position of the picture in pixels.

NN - The nickname of the picture.

(oPic As Object,

ByVal PicType As DV_PICTURES,

Optional Symbol As Variant,

Optional Replace As Variant,

Optional Xpos as Long,

Optional Ypos as Long,

Optional CenterOnScreen As Boolean = False

Optional NewCaption As String) As Boolean

Opens a predefined DeltaV picture at the indicated coordinates. The picture will be opened immediately adjacent to oPic and is not allowed to be split across screens. If the picture will open across screens, it is repositioned to the other side of the picture. Returns True if the picture was successfully opened.

oPic - The picture reference of the parent picture.

PicType - Enumeration of the DeltaV predefined picture.

Symbol- Tag group symbol to be replaced.

Replace - Tag group replace value.

Xpos - X or left position of the picture.

Ypos - Y or top position of the picture.

CenterOnScreen - Position picture in center of screen.

NewCaption - The string displayed in the title bar of the picture.

(ByVal NewPicture As String,

Optional OldPicture As String,

Optional TagGrp As String,

Optional ErrMode As Integer)

Replaces an existing picture with a new picture.

NewPicture - Name of picture to open. Defaults to the Pic folder if full path is not included.

OldPicture - Name of the picture to be replaced. If not specified, defaults to the active picture.

TagGrp - Name of tag group file if required by NewPicture.

ErrMode - Indicates how errors should be handled. Use the default value and the default error handler is called.

(ByVal Feature As DV_IFIX_REVISION,

ByVal RevInfo As String) As Boolean

Sets the feature revision information string. The feature must be defined in the DV_IFIX_REVISION enumeration. True if the feature revision is valid; otherwise, False.

Feature - Enumeration of the feature revision data.

RevInfo - Feature revision information string.

(ByVal NewInputTimeout As Integer)

Sets the current input timeout value. Input timeout value can be set from 1 to 600 seconds. A value of 0 disables the input timeout. The NewInputTimeout is clamped from 0 to 600 seconds. Default input timeout is 30 seconds.

The input timeout is used when DeltaV Operate requests data from the user. The input forms are modal and all display processing is halted until the user enters the data or cancels the operation. When the timeout period expires, the input form is closed and display processing resumes.

NewInputTimeout - New timeout value.

(X As Long,

Y As Long)

Returns the X and Y resolution of a desktop. This is the visible region of the display that might span multiple monitors.

X - Number of horizontal pixels.

Y - Number of vertical pixels.

(ByVal Value As Long)

Disables the multiple monitor feature.

Value - The value (1) to disable the feature.

(oPic As Object,

Xpos As Long,

Ypos As Long) As Boolean

Returns True when it gets the x and y coordinates of the picture referenced.

oPic - The object reference to the picture.

Xpos - X or left position of the picture.

Ypos - Y or top position of the picture.

( ) As Long

Returns the current value for the input timeout. There are no input parameters for this function.

(

Optional ErrorText As Variant,

Optional ByVal ClearError As Boolean) As Long

Returns the last error as Long.

ErrorText -The error text that corresponds to the error number.

ClearError - True to clear the last error. False to retain the last error.

(PN, ByVal Screen As DV_SCREENS, ByVal AsPopUp as Boolean) As String

Returns the full path of a copy of the specified main picture.

PN - The main picture's name.

Screen - Enumeration of the screen on which to open the picture.

AsPopUp - If True, the main picture's copy is opened as a popup picture. If False, the main picture's copy is opened as a main picture.

(ByVal PicType As DV_PICTURES)

Returns the relative horizontal offset of a picture relative to the upper left corner of a screen as Long.

PicType - Enumeration of picture.

(ByVal PicType As DV_PICTURES)

Returns the relative vertical offset of a picture relative to the upper left corner of a screen as Long.

PicType - Enumeration of picture.

(ByVal CurMon As DV_SCREENS) As Boolean

Returns True if the CurMon in the operator keyboard screen; otherwise, returns False.

CurMon - Enumeration of the screen.

(byVal ModList,

ByVal Screen As DV_SCREENS) As Boolean

Pre-populates the module history list.

ModList - An array of strings that contains the module names.

Screen - Enumeration of the screen.

(oPic As Object) As Long

Returns the monitor number (1, 2, 3, 4 - as configured by the video driver ) on which the picture is open.

oPic - The object reference to the picture.

(

Optional Xpos As Long,

Optional Ypos As Long) As Long

Returns the monitor number (1, 2, 3, 4- as configured by the video driver ) for where the cursor is.

Xpos - X or left position of the picture.

Ypos - Y or top position of the picture.

( ) As DV_SCREEN_ORIENTATION

Returns the monitor orientation as determined from the desktop size and screen resolution.

(oPic As Object,

PicType As DV_PICTURES,

Optional NewScreen As DV_SCREENS)

Moves a picture to another screen. If a new screen is not specified, a dialog will display allowing the operator to select the new screen.

When the picture is opened on the new screen, it will be in the same relative X and Y location as the old screen.

This procedure does nothing on a single screen system.

oPic - Object reference to the picture to be moved.

PicType - This parameter is not used.

NewScreen - Enumeration of the screen to move the picture to.

(X As Long,

Y As Long)

Returns the number of screens horizontally and vertically.

X - Number of screens horizontally.

Y - Number of screens vertically.

(ByVal PicName As String,

byVal Screen As DV_SCREENS,

Optional Xpos As Long,

Optional Ypos As Long,

Optional NN As String) As Boolean

Opens a picture on the desired screen. Coordinates are relative to the upper left corner of the screen. Returns True if picture exists on the disk. Picture might not open for other reasons that are not indicated in the status.

PicName - Name of the picture to open. Defaults to the Pic folder if full path is not included.

Screen - Enumeration of screen on which to open the picture.

Xpos - Horizontal position of the picture in pixels.

Ypos - Vertical position of the picture in pixels.

NN - NickName of the picture.

(ByVal PictureName As String,

ByVal Screen as DV_SCREENS,

Optional PictureAlias As String

Optional PictureCaption As String

Optional PicType as DV_PICTURES

Optional offsetX As Long

Optional offsetY As Long) As Boolean

Opens a user picture on the desired screen. Returns True if the picture was successfully opened.

PictureName - Name of picture to open. Defaults to the Pic folder if full path is not included.

Screen - Enumeration of screen on which to open the picture.

PictureAlias - Pictures alias or nickname.

PictureCaption - Caption of the picture that will displayed on the left side of the title bar.

PicType - Enumeration of picture.

offsetX - The offset of the horizontal boundary.

offsetY - The offset of the vertical boundary.

( ) As Boolean

Returns True if the screen is the Operator Keyboard screen.

(ByVal PicType As DV_PICTURES)

Returns the height of the indicated picture in pixels.

PicType - Enumeration of picture.

(ByVal PicList,

ByVal Screen As DV_SCREENS) As Boolean

Pre-populates the main history list.

PicList - An array of strings that contains the picture names.

Screen - Enumeration of the screen.

(ByVal Screen As DV_SCREENS,

ByVal PicType As DV_PICTURES) As String

Returns the predefined picture name as string.

Screen - Enumeration of screen.

PicType - Enumeration of picture.

(ByVal Screen As DV_SCREENS,

ByVal PicType As DV_PICTURES) As String

Returns the predefined pictures' nickname as a string.

(ByVal PicType As DV_PICTURES) as Long

Returns the width of the indicated picture in pixels.

PicType - Enumeration of picture.

(ByVal PicType As DV_PICTURES)

Returns the relative horizontal offset of a picture relative to the upper left corner of a screen as Long.

PicType - Enumeration of picture.

(ByVal PicType As DV_PICTURES)

Returns the relative vertical offset of a picture relative to the upper left corner of a screen as Long.

PicType - Enumeration of picture.

(uForm As Object,

Optional Xpos As Long,

Optional Ypos As Long) As Boolean

Positions the upper left corner of the form at a specific location. If Xpos and Ypos are not specified, the form is positioned at the cursor. If the new position of the form will result in it being split across two screens, the forms position will be adjusted as needed to keep the form on one screen.

uForm - Object reference the form to be positioned.

Xpos - New X position for the form.

Ypos - New Y position for the form.

(oPic As Object,

ByRef offsetX As Long,

ByRef offset Y As Long)

Positions the referenced picture entirely on the screen from theX and Y offsets given and the resolution of the screen.

oPic - The object reference of the picture.

offsetX - The offset of the horizontal boundary.

offsetY - The offset of the vertical boundary.

(ByVal NewPic As String,

ByVal Screen As DV_SCREENS,

Optional TagGrp As String) As Boolean

Replaces the picture on the indicated screen with NewPic.

NewPic - Name of picture to open. Defaults to the Pic folder if full path is not included.

Screen - Enumeration of the screen on which to open NewPic.

TagGrp - Name of tag group file if required by NewPic.

( ) As DV_SCREEN_ORIENTATION

Returns the current screen layout.

(oPic As Object) As Long

Returns the name of the screen that the picture, oPic, is on.

oPic - Object reference to a picture.

(oPic As Object) As Long

Returns the screen on which oPic is currently being displayed. This is a dynamic check so if the picture is moved to another screen by dragging, it will return the new screen number.

oPic - Object reference to the picture.

(

Optional Xpos As Long,

Optional Ypos As Long) As Long

Returns the screen that contains the point indicated by Xpos and Ypos. If Xpos and Ypos are not specified, the current cursor location is used.

Xpos - The X coordinate.

Ypos - The Y coordinate.

(ByVal Screen As DV_SCREENS

X As Long

Y As Long)

Contains the center point of the indicated screen in the X and Y values.

Screen - Enumeration of screen.

X - Absolute horizontal center of the indicated screen in pixels.

Y - Absolute vertical center of the indicated screen in pixels.

(X As Long,

Y As Long)

Contains the X and Y resolution of a screen. Note: The resolution is the same for all screens.

X - Number of horizontal pixels on each screen.

Y - Number of vertical pixels on each screen.

(ByVal Screen As DV_SCREENS) As Long

Returns the absolute horizontal position of the upper left corner of the indicated screen.

Screen - Enumeration of screen.

(ByVal Screen As DV_SCREENS) As Long

Returns the absolute vertical position of the upper left corner of the indicated screen.

Screen - Enumeration of screen.

( )

Displays the dialog to select and set the default screen.

(ByVal ABHelpName As String,

ByVal Screen As DV_SCREENS)

Defines the help file to open for a screen's alarm banner.

ABHelpName - Name of the help file.

Screen - Enumeration of screen.

(ByVal AlarmBannerName As String,

ByVal Screen As DV_SCREENS)

Populates the screen with the initial alarm banner.

AlarmBannerName - Name of the alarm banner picture file.

Screen - Enumeration of the screen.

(ByVal PicName As String,

ByVal Screens As DV_SCREENS)

Sets the initial picture that will be opened on the indicated screen when DeltaV Operate is started. The picture must be on the disk to succeed. This procedure is called from frs_Schedule when frsVariables.gs_initial_Main(X).currentvalue is changed, usually from UserSettings.grf. "X" is the screen number from 1 to 4 (PRIMARY_SCREEN to USER2). A message is written to the trace object when the initial picture is changed.

PicName - Name of the new initial picture.

Screen - Enumeration of the screen.

(ByVal ToolBarName As String,

ByVal Screen As DV_SCREENS)

Populates the screen with the initial toolbar.

ToolBarName - Name of the toolbar picture file.

Screen - Enumeration of screen

(ByVal Screen As DV_SCREENS,

ByVal PicType As DV_PICTURES,

ByVal NewRelativeXPos As Long,

ByVal NewRelativeYPos as Long) As Boolean

Sets the X and Y coordinates of the picture being opened.

Screen - Enumeration of screen

PicType - Enumeration of picture type

NewRelativeXPos - the X coordinate of the picture starting at the top left of the screen.

NewRelativeYPos - the Y coordinate of the picture starting at the top left of the screen.

(ByVal TBHelpName As String,

ByVal Screen As DV_SCREENS)

Defines the help file to open for the toolbar.

TBHelpName - Name of the help file.

Screen -Enumeration of screen.

( ) As Long

Returns the total number of screens detected on the computer.

(X As Long,

oPic As Object) As Long

Returns the X coordinate of the picture referenced relative to the upper left corner of the screen.

X -The left coordinates of the picture in pixels.

oPic - The object reference picture.

(Y As Long,

oPic As Object) As Long

Returns the Y coordinate of the picture referenced relative to the upper left corner of the screen.

Y - The top coordinate of the picture in pixels.

oPic - The object reference picture.

Returns the current default screen. The property, frsDefaultScreen is returned as DV_SCREENS.

As String

Returns the DeltaV help path. Equivalent to system.picturepath & "\Help\".

As String

Returns the DeltaV faceplate function block path. Equivalent to system.picturepath & "\FaceplateFB\".

As String

Returns the DeltaV faceplate path. Equivalent to system.picturepath & "\Faceplate\".

(ByVal DefMon As DV_SCREENS)

This property sets the default screen. If Screen is not valid, the default screen is not set and the DVDesktopError is set to SCREEN_NUMBER_OUT_OF_RANGE.

DefMon - Enumeration of the screen.

As String

Returns the main picture's temp path where the copy is.

As String

Returns the DeltaV picture path. Equivalent to system.picturepath.

As String

Returns the DeltaV POC faceplate path. Equivalent to system.picturepath & "\POC\Faceplate\".

As String

Returns the DeltaV standard path. Equivalent to system.picturepath & "\Standard\".

As String

Returns the DeltaV temp path. Equivalent to system.picturepath & "\Temp\".

As String

Returns the DeltaV trace path. Equivalent to system.picturepath & "\Standard\".

As String

Returns the DeltaV trend function block path. Equivalent to system.picturepath & "\TrendFB\".

As String

Returns the DeltaV trend path. Equivalent to system.picturepath & "\Trend\".

Returns true if the machine is accessed using a terminal (remote desktop).

Returns the Remote Desktop Services session's name. Returns a null value if not on a Remote Desktop Services session.

Returns the prefix for the tag group file.