IOleUndoManager::GetOpenParentState method (ocidl.h)
Retrieves state information about the innermost open parent undo unit.
Syntax
HRESULT GetOpenParentState(
[out] DWORD *pdwState
);
Parameters
[out] pdwState
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
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 2000 Professional [desktop apps only] |
| Minimum supported server | Windows 2000 Server [desktop apps only] |
| Target Platform | Windows |
| Header | ocidl.h |