IDebugDocumentHelper::AddDeferredText


HRESULT AddDeferredText( ULONG cChars, DWORD dwTextStartCookie );

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Value	Description
S_OK	The method succeeded.
E_FAIL	The method failed.

This method allows the host to defer providing the characters to add until they are needed, while allowing the helper to generate accurate notifications and size information. The dwTextStartCookie parameter is a cookie, defined by the host, which represents the starting position of the text. Subsequent calls to IDebugDocumentText::GetText must provide this cookie. For example, in a host that represents text in DBCS, the cookie could be a byte offset.

It is assumed that a single call to IDebugDocumentText::GetText can get characters from multiple calls to AddDeferredText. Helper classes may also ask for the same range of deferred characters more than once.

Note
Calls to AddDeferredText should not be mixed with calls to AddUnicodeText or AddDBCSText. If this occurs, E_FAIL is returned.

Reference

IDebugDocumentHelper::AddUnicodeText
IDebugDocumentHelper::AddDBCSText
IDebugDocumentText::GetText

Concepts

IDebugDocumentHelper Interface

Parameters

Return Value

Remarks

See Also

Reference

Concepts