Skip to content

psHome - cWorkspace

Contains the path that the Workspace should use as its "home"

Type: Property
Access: Read/Write
Data Type: String
Parameters: None

Syntax

Property String psHome
Access Type Syntax
Read Access: Get psHome to StringVariable
Write Access: Set psHome to StringVariable/Value

Description

The psHome property contains the path that the Workspace should use as its "home." That is, the single directory that will be used to offset the relative paths of the properties containing paths (psDataPath, for example.)

This property will not have a value until a Workspace has been opened (using, for example, the OpenWorkspace or OpenWorkspaceFile functions). You can also set this property before opening a Workspace. When you do, this property will not be modified during the opening of a Workspace.

The value of this property corresponds to the Home entry in the Workspace file; however, it differs in that while the entry in the Workspace file can contain a relative path, this property will always contain the path fully qualified.