Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

xmstringtableunparse(3) [redhat man page]

XmStringTableUnparse(library call)										XmStringTableUnparse(library call)

NAME
XmStringTableUnparse -- A convenience function that converts a table of compound strings to an array of text SYNOPSIS
#include <Xm/Xm.h> XtPointer * XmStringTableUnparse( XmStringTable table, Cardinal count, XmStringTag tag, XmTextType tag_type, XmTextType output_type, XmParseTable parse, Cardinal parse_count, XmParseModel parse_model); DESCRIPTION
XmStringTableUnparse takes an array of compound strings, allocates a string array for the type of characters determined by type with an equal number of slots, calls XmStringUnparse on each compound string in table, and inserts the resulting string in the corresponding slot in the array. table Specifies an XmStringTable containing the compound string to be converted. count Specifies the number of compound strings in table. tag Specifies the tag to be used in matching with text segments. The two types of tag types are XmFONTLIST_DEFAULT_TAG and _MOTIF_DEFAULT_LOCALE. Only segments tagged with tag will be returned. If tag is NULL, all segments will be matched. tag_type Specifies the type of tag to be searched for. These types include XmMULTIBYTE_TEXT, XmWIDECHAR_TEXT, and XmCHARSET_TEXT. output_type Specifies the type of text to be generated. These types include XmMULTIBYTE_TEXT, XmWIDECHAR_TEXT, and XmCHARSET_TEXT. parse Specifies the parse table to be used. parse_count Specifies the number of items in parse. parse_model Specifies which non-text components to be considered in matching in parse_table. Possible values are: XmOUTPUT_ALL Puts out all matching components. XmOUTPUT_BETWEEN Puts out only those matching components that are between two matching text components. XmOUTPUT_BEGINNING Puts out only those matching components that are at the beginning of a matching text component. XmOUTPUT_END Puts out only those matching components that are at the end of a matching text component. XmOUTPUT_BOTH Puts out only those matching components that are at the beginning or end of a matching text component. RETURN
Returns an allocated array of allocated strings. The application is responsible for managing the allocated space. The application can recover the allocated strings space by calling XtFree count times (that is, one time for each allocated string). The application can then recover the allocated array by calling XtFree on the allocated array itself. RELATED
XmStringTab. XmStringTableUnparse(library call)

Check Out this Related Man Page

XmStringParseText(library call) 										   XmStringParseText(library call)

NAME
XmStringParseText -- A function that converts a character string to a compound string SYNOPSIS
#include <Xm/Xm.h> XmString XmStringParseText( XtPointer text, XtPointer *text_end, XmStringTag tag, XmTextType type, XmParseTable parse_table, Cardinal parse_count, XtPointer call_data); DESCRIPTION
XmStringParseText converts characters specified in text to corresponding components in the returned compound string. The resulting compound string consists of at least one locale or charset tag component and a series of XmString text components and other components. The conver- sion proceeds according to the parse information contained in parse_table. See the Motif Programmer's Guide for more information about parsing and parse tables. o If type is XmCHARSET_TEXT, the associated tag is interpreted as a charset name. If tag has a value of NULL, a charset component whose value is the result of mapping XmFONTLIST_DEFAULT_TAG is created. o If type is XmMULTIBYTE_TEXT or XmWIDECHAR_TEXT, the associated tag is interpreted as a language environment name. If tag has a value of NULL, a locale component with a value of _MOTIF_DEFAULT_LOCALE is created. If type is XmMULTIBYTE_TEXT or XmWIDECHAR_TEXT, tag must be NULL or _MOTIF_DEFAULT_LOCALE. XmStringParseText also scans the string for characters that have matches in parse_table. Whenever a match is found, the text up to that point is concatenated with the mapped component. text Specifies the NULL-terminated string containing characters of a type determined by type. This is updated to point to after the last character scanned. text_end Specifies a pointer into text. If a NULL is supplied to the text_end parameter, then XmStringParseText parses text until NULL is encountered, or until it reaches a point in text where it is directed to stop (for example, by a parse_proc). Otherwise, the value supplied to the text_end parameter is the pointer into text where parsing is to stop, and the returned character is the one where parsing did stop. tag Specifies the tag to be used in creating the result. The type of string tag created (charset or locale) depends on the text type and the passed in tag value. If the tag value is NULL and if type indicates that a charset string tag should be created, the string tag has the value that is the result of mapping XmFONTLIST_DEFAULT_TAG. If type indicates a locale string tag, the string tag has the value _MOTIF_DEFAULT_LOCALE. type Specifies the type of text and the tag type. If a locale tag should be created, type has a value of either XmMULTIBYTE_TEXT or XmWIDECHAR_TEXT. If type has value of XmCHARSET_TEXT, a charset tag will be created. parse_table Specifies the parse table to be used in scanning for characters to be converted to other compound string components. parse_count Specifies the number of entries in parse_table. call_data Specifies data to be passed to the parse procedures. RETURN
Returns a new compound string. The function allocates space to hold the returned compound string. When the application no longer needs the returned compound string, the application should call XmStringFree. RELATED
XmString(3), XmStringFree(3), XmParseTable(3), XmParseMapping(3). XmStringParseText(library call)
Man Page