Skip to content

psHelpPath - cWorkspace

Contains the path(s) of the Workspace used to store the help-related files

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

Syntax

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

Description

The psHelpPath 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 HelpPath entry in the Workspace file; however, it differs in that while the entry in the Workspace file can contain relative paths, this property will always contain the paths fully qualified.

You can discover how many paths are contained in this property by using the CountOfPaths function, and you can retrieve an individual path by using the PathAtIndex function.