ICodeWarriorAccessPaths

With this interface you can perform the following operations:

• Retrieving User Access Paths - UserAccessPaths
• Retrieving System Access Paths - SystemAccessPaths
• Retrieving the Searching of User Access Paths - AlwaysSearchUserPaths
• Setting the Searching of User Access Paths - AlwaysSearchUserPaths
• Creating Access Paths - CreateAccessPath
• Creating Access Paths By FileSpec - CreateAccessPathByFileSpec
• Saving the Changes - ApplyChanges

See Listing 3.3 for an example of how to use some of the access path functionality in a real script. You will want to call the ApplyChanges method to save your changes, as discussed in "Saving the Changes - ApplyChanges."

Retrieving User Access Paths - UserAccessPaths

This allows you to get a collection of user access paths. Refer to the IDE User Guide for a discussion of access paths and their settings.

Arguments

None

Return Value

ICodeWarriorAccessPathCollection** pval - the access path collection.

Retrieving System Access Paths - SystemAccessPaths

This allows you to get a collection of system access paths. Refer to the IDE User Guide for a discussion of access paths and their settings.

Arguments

None

Return Value

ICodeWarriorAccessPathCollection** pval - the access path collection.

Retrieving the Searching of User Access Paths - AlwaysSearchUserPaths

This allows you to determine if the user access paths are set to always be searched. Refer to the IDE User Guide for a discussion of access paths and their settings.

Arguments

None

Return Value

VARIANT_BOOL* pval - true or false, whether the access path will always be searched.

Setting the Searching of User Access Paths - AlwaysSearchUserPaths

This allows you to determine if the user access paths are set to always be searched. Refer to the IDE User Guide for a discussion of access paths and their settings.

Arguments

AlwaysSearchUserPaths takes the arguments shown in Table 3.4:

Argument	Functionality
VARIANT_BOOL pval	true or false, whether to always search the access path or not.

ICodeWarriorAccessPath.AlwaysSearchUserPaths Arguments:

Return Value

None

Creating Access Paths - CreateAccessPath

This allows you to create an access path.

Arguments

CreateAccessPath takes the arguments shown in Table 3.5. You should build a ICodeWarriorAccessPath to pass into this call.

Argument	Functionality
BSTR path	The path to set.
VARIANT_BOOL Recursion	true or false, whether to recursion on the access path or not.
EAccessPathLocation inLocation	the location
EAccessPathType inType	the access path type
ICodeWarriorAccessPath** pval	the access path object

ICodeWarriorAccessPath.CreateAccessPath Arguments:

Return Value

None

Creating Access Paths By FileSpec - CreateAccessPathByFileSpec

This allows you to create an access path.

Arguments

CreateAccessPathByFileSpec takes the arguments shown in Table 3.6. You should build a ICodeWarriorAccessPath to pass into this call.

Argument	Functionality
IFileSpec* path	The path to set.
VARIANT_BOOL Recursion	true or false, whether to recursion on the access path or not.
EAccessPathLocation inLocation	the location
EAccessPathType inType	the access path type
ICodeWarriorAccessPath** pval	the access path object

ICodeWarriorAccessPath.CreateAccessPathByFileSpecArguments:

Return Value

None

Saving the Changes - ApplyChanges

Call this method to save changes you have made to access paths.

Arguments

None