XmStringInitContext - Man Page

A compound string function that creates a data structure for scanning an XmString component by component

Synopsis

#include <Xm/Xm​.h>
Boolean XmStringInitContext(
XmStringContext * context,
XmString string);

Description

XmStringInitContext creates a context to allow applications to read out the contents of a compound string component by component​. A Boolean status is returned to indicate that the context could not be initalized​.

If the function returns True, the function will allocate space to hold the returned context​. The application is responsible for managing the allocated space​. The memory can be recovered by calling XmStringFreeContext​.

context

Specifies a pointer to the allocated context

string

Specifies the string

Return

Returns True if the context was allocated

Referenced By

XmString(3), XmStringCreate(3), XmStringFreeContext(3), XmStringGetNextComponent(3), XmStringGetNextSegment(3), XmStringPeekNextComponent(3).