ITextDocument::Freeze method

Increments the freeze count.

Syntax

HRESULT Freeze(
  long *pValue
);

Parameters

pValue

Type: long*

The updated freeze count.

Return value

Type: HRESULT

If the ITextDocument::Freeze count is nonzero, it returns S_OK. If the ITextDocument::Freeze count is zero, it returns FALSE.

Remarks

If the freeze count is nonzero, screen updating is disabled. This allows a sequence of editing operations to be performed without the performance loss and flicker of screen updating. To decrement the freeze count, call the ITextDocument::Unfreeze method.

Requirements

See also

Reference

ITextDocument

Unfreeze

BeginEditCollection

Conceptual

Text Object Model

Send comments about this topic to Microsoft

Build date: 10/27/2012