IOleUndoManager::GetOpenParentState method

Retrieves state information about the innermost open parent undo unit.

Syntax


HRESULT GetOpenParentState(
  [out] DWORD *pdwState
);

Parameters

pdwState [out]

A pointer to a variable that receives the state information. This information is a value taken from the UASFLAGS enumeration.

Return value

This method returns S_OK if there is an open parent unit and its state was successfully returned or the undo manager is disabled; otherwise, S_FALSE.

Remarks

Notes to Callers

When checking for a normal state, use the UAS_MASK value to mask unused bits in the pdwState parameter to this method for future compatibility.

Notes to Implementers

If there is an open parent unit, this method calls IOleParentUndoUnit::GetParentState.

If the undo manager is disabled, it should fill the pdwState parameter with UAS_BLOCKED and return S_OK.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

OCIdl.h

IDL

OCIdl.idl

IID

IID_IOleUndoManager is defined as D001F200-EF97-11CE-9BC9-00AA00608E01

See also

IOleUndoManager
UASFLAGS

 

 

Show: