DwtStringInitContext(3Dwt)

Name

DwtStringInitContext − Initializes a compound-string context structure needed by DwtGetNextSegment

Syntax

Boolean DwtStringInitContext(context, compound_string)
DwtCompStringContext context;
DwtCompString compound_string;

Arguments

contextSpecifies the compound-string context structure initialized by DwtStringInitContext.

compound_string
Specifies the compound-string.

Description

The DwtStringInitContext function initializes a compound-string context structure. The context structure is needed for calling DwtGetNextSegment. For performance reasons, DwtStringInitContext is preferred over DwtInitGetSegment.

After fetching the necessary segments using DwtGetNextSegment, call DwtStringFreeContext to free the context structure.

Return Values

This function returns one of these status return constants:

True	The compound-string context structure has been successfully initialized.
False	The compound-string context structure has not been successfully initialized.