Share via

CPane::SaveState

  • Article

Saves the state of the pane to the registry.

virtual BOOL SaveState(
   LPCTSTR lpszProfileName = NULL,
   int nIndex = -1,
   UINT uiID = (UINT) -1
);

Parameters

  • [in] lpszProfileName
    Profile name.

  • [in] nIndex
    Profile index.

  • [in] uiID
    Pane ID.

Return Value

TRUE if the state was saved successfully; otherwise, FALSE.

Remarks

The framework calls this method when it saves the state of the pane to the registry. Override SaveState in a derived class to store additional information.

When you override this method, also call the base method, and return FALSE if the base method returns FALSE.

Requirements

Header: afxpane.h

See Also

Reference

CPane Class

Hierarchy Chart