2.1.14.3.6 get_folder_pages_name

Description

Get all page names in one folder.

Syntax

int get_folder_pages_name( Folder fld, vector<string> & vsGraphs, int nPageType = -1, bool bRecursive = false, int nPageShowState = -1, bool bIncludeShortcut = false )

Parameters

fld

[input] the folder which contains pages to be retrieved

vsGraphs

[output] the vector contains all the page names

nPageType

[input] to specify page type if not -1

bRecursive

[input] whether to get page names in subfolders

nPageShowState

[input] specify the wanted page state, can be PAGE_OPEN, PAGE_MINIMIZED, PAGE_HIDDEN, -1 means all kinds of state

bIncludeShortcut

[input] indicate whether to include shortcut pages

Return

return the number of pages retrieved.

Examples

EX1

void    get_folder_pages_name_ex1()
{
    Folder fdr = Project.RootFolder; //get root folder
    vector<string> vsPageNames;
    int nPages = get_folder_pages_name(fdr, vsPageNames, EXIST_WKS, true, -1, true); //get all worksheetpage in current project
    out_int("Number of WorksheetPage : ", nPages);
}

Remark

See Also

Header to Included

origin.h

Reference