2.2.4.32.30 OriginObject::GetStorage

GetStorage

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

Description

Access storage areas.

Syntax

storage GetStorage( LPCSTR lpcszName, bool bAdd = FALSE )

Parameters

lpcszName: [input] the storage name
bAdd: [input] TRUE on add a new if wanted storage is not existed, else for FALSE.

Return

storage object

Examples

EX1

// Check the system storage objects on the active page
// For example, import data using the Import Wizard to ensure creation of system storage object
void OriginObject_GetStorage_Ex1()
{
    Tree    tr;
    storage st;
    Page pg = Project.Pages();
    
    st = pg.GetStorage("system");    // System, User and Files are examples of storage objects
                                    // Wave is also an example which is created when you import a sound (WAV) file
    tr = st;
    out_tree(tr);
}