IProcessAnalyst​.PrimaryPath [Property][Get/Set]

Specifies the primary location for saving and loading Process Analyst views.

Defined As

• [VBA] String PrimaryPath

• [Cicode] STRING PrimaryPath

• [C++] BSTR PrimaryPath

Execution Result

If the property get/set succeeds, the return value will be Success. If the return variable is bad, the return value will be InvalidArgument.

Remarks

The primary and secondary path properties together provide a file redundancy option for large systems that need to store Process Analyst Views in a shared location. Whenever a load operation occurs from either of these locations, the loaded file will be synchronized with each location, such that the latest version of the file appears in both locations.

Calling Syntax

Assumes you have a page called "myPage" and the Process Analyst has been named "AN35".

[VBA]

Sub Example()
Dim path As String
`Retrieve the path
path = myPage_AN35.PrimaryPath
`Set the path
myPage_AN35.PrimaryPath = "\\computer1\PA Views"
End Sub

[Cicode]

FUNCTION Example()
OBJECT hProcessAnalyst = ObjectByName("AN35");
STRING path;
// Retrieve the path
path = _ObjectGetProperty(hProcessAnalyst, "PrimaryPath");
// Set the path
_ObjectSetProperty(hProcessAnalyst, "PrimaryPath", "\\computer1\PA Views");
END

See Also

IProcessAnalyst.SecondaryPath [Property][Get/Set]

IProcessAnalyst.LoadFromFile [Method]

IProcessAnalyst.SaveToFile [Method]