PageBase::GetName

GetName

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

Description

Get the name of a Page object by argument.

Syntax

BOOL GetName( string & strName )

Parameters

strName: [output]The string that will recieve the name of the page.

Return

Returns TRUE for success or FALSE for failure.

Examples

EX1

//Get the name of current active page
void PageBase_GetName_ex1()
{
    PageBase pb;
    pb = Project.Pages(); // Get the project's active page
        string strName;
        if( pb.GetName(strName) )//Get the name of the page
                printf("Active page is named %s\n", strName);
        else
                printf("Failed to get page name\n");
}