2.2.4.38.1 Project::ActivateFolder

ActivateFolder

1 Description
2 Syntax
3 Parameters
4 Return
5 Examples
6 Remark
7 See Also
8 Header to Include

Description

Set the project's active folder. Specified path can be relative or absolute and is not case sensitive.

Syntax

BOOL ActivateFolder( LPCSTR lpszPath )

Parameters

lpszPath: [input]the path to the folder to be activated. The path can be absolute, in which; case it has to start with the '/' character denoting the root folder, and; each subfolder is separated by a '/' character (Example: "/mysub/musubsub"); or it can be relative to the current active folder, in which case the path; must not start with '/' (Example: "mysub/mysubsub" where "mysub" is the subdolder; within the current active folder).

Return

TRUE for success, otherwise FALSE.

Examples

EX1

// For this example to run, create a subfolder named "MySub" in the project's root folder.
// Make sure that the root folder is active.
// After the function executes, "MySub" will be the active folder.
void    Project_ActivateFolder_ex1()
{
    string        strPath = "/MySub";

    if (Project.ActivateFolder(strPath))
        out_str("Folder activation succeeded.");
    else
        out_str("Folder activation failed!");
}