PageBase::GetOrder

GetOrder

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

Description

Order, when >= 0, it is the order of the page in a slide show of the folder. When -1, the page is hidden from a slide show. Gets the order of a page in a given folder. If pFolder is NULL (default) will return its order in the current folder.

Syntax

int GetOrder( Folder * pFolder = NULL )

Parameters

pFolder: [input]the folder where the order if the page is requested

Return

Returns the order of the page in the folder if the folder contains the page or a shortcut to the page, otherwise returns -1, which is same as hidden from slide show.

Examples

EX1

void PageBase_GetOrder_ex1()
{
    PageBase pb;
    pb = Project.Pages(); // Get the project's active page
    if( pb.IsValid() )
    {
        int nOrder = 1;
        BOOL nRet = pb.SetOrder(nOrder);
        printf("The order is %d\n", pb.GetOrder());
    }
}