LoadDockingState

Description

Loads two arrays of equal size: type names of persisted sheets and the corresponding IDs.

Applies to

Window objects

Syntax

LoadDockingState ( regkey, windowtypes, sheetnames )

Argument

Description

regkey

The registry key where the information was stored using the LoadDockingState function.

windowtypes

A string array of window types for all the child windows that were persisted.

sheetnames

A string array of the unique IDs for the persisted child windows corresponding to the types in the sheetnames array.


Return value

Integer.

Returns 1 if it succeeds and -1 if an error occurs. If any argument's value is null, LoadDockingState returns null.

Usage

To retrieve the MDI states that were saved using the SaveDockingState function, uses LoadDockingState to get the window information from the registry. Next, use OpenSheetFromDockingState or OpenSheetWithParmFromDockingState to open each of the persisted sheets. Finally, use CommitDocking to do the final arrangement and make the sheets visible.