Name

DwtInitGetSegment − Returns the initialized context of the compound-string. 

Syntax

int DwtInitGetSegment(context, compound_string)
     DwtCompStringContext *context;
     DwtCompString compound_string;

Arguments

contextSpecifies a context to be filled by this function.  You should have previously allocated this context. 

compound_string
Specifies the compound-string.

Description

The DwtInitGetSegment function returns the initialized context associated with the compound-string you specified (compound_string).  You must use this returned context in a call to DwtGetNextSegment. 

Note that the performance of DwtInitGetSegment (used in conjunction with DwtGetNextSegment to fetch multiple segments from a compound-string) has degraded from Version 1.0 of the toolkit. 

A new function, DwtStringInitContext, not only provides better performance, it also creates the context structure that you must allocate separately when using DwtInitGetSegment.  To improve performance, convert calls from DwtInitGetSegment to DwtStringInitContext, and use DwtStringFreeContext to free the context structure when you are finished with it. 

Return Value

This function returns one of these status return constants:

See Also

DwtGetNextSegment (3Dwt), DwtStringFreeContext (3Dwt), DwtStringInitContext (3Dwt)
Guide to the XUI Toolkit: C Language Binding
Guide to the XUI Toolkit Intrinsics: C Language Binding