IOleParentUndoUnit::GetParentState

Returns state information about the innermost open parent undo unit.

HRESULT GetParentState(
  DWORD* pdwState   //Pointer to state information
);

Parameters

pdwState: [out] Pointer to state information. This information is a value taken from the UASFLAGS enumeration.

Return Values

S_OK: The parent's state was successfully returned.

Remarks

Note to Implementers

If the unit has an open child, it should delegate this method to that child. If not, it should fill in *pdwState values appropriately and return. Note that a parent unit must never be blocked while it has an open child. If this happened it could prevent the child unit from being closed, which would cause serious problems.

Note 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. For example:

QuickInfo

  Windows NT: Use version 4.0 or later. New for OC96.
  Windows: Use Windows 95 or later. New for OC96.
  Windows CE: Unsupported.
  Header: Declared in ocidl.h.