ITextDocument::Unfreeze method (tom.h)

Decrements the freeze count.

Syntax

HRESULT Unfreeze(
  long *pCount
);

Parameters

pCount

Type: long*

The updated freeze count.

Return value

Type: HRESULT

If the freeze count is zero, the method returns S_OK. If the method fails, it returns S_FALSE, indicating that the freeze count is nonzero. For more information about COM error codes, see Error Handling in COM.

Remarks

If the freeze count goes to zero, screen updating is enabled. This method cannot decrement the count below zero, and no error occurs if it is executed with a zero freeze count.

Note, if edit collection is active, screen updating is suppressed, even if the freeze count is zero.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header tom.h
DLL Msftedit.dll

See also

BeginEditCollection

Conceptual

Freeze

ITextDocument

Reference

Text Object Model