Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
XmStringToXmStringTable(3) Library Functions Manual XmStringToXmStringTable(3)

NAME
       XmStringToXmStringTable	-- A convenience function that converts	a sin-
       gle compound string to a	table of compound strings

SYNOPSIS
       #include	<Xm/Xm.h>
       Cardinal	XmStringToXmStringTable(
       XmString	string,
       XmString	break_component,
       XmStringTable *table);

DESCRIPTION
       XmStringToXmStringTable takes as	input a	single compound	string	and  a
       specified  string component (such as a tab) and returns a table of com-
       pound strings consisting	of portions of string delimited	by  components
       matching	break_component. The components	marking	breaks will not	appear
       in the resulting	table.

       string	 Specifies the XmString	to be converted.

       break_component
		 Specifies the XmStringComponent that will be used to indicate
		 where	to split string	to form	the individual elements	of ta-
		 ble. The most useful types will be XmSTRING_COMPONENT_SEPARA-
		 TOR and XmSTRING_COMPONENT_TAB. Refer to  the	XmStringCompo-
		 nentType(3)  reference	 page  for a complete list of possible
		 component types.  Note,  however,  that  the  XmSTRING_COMPO-
		 NENT_UNKNOWN component	is not a possible type.

       table	 Returns  the equivalent XmStringTable.	 The function will al-
		 locate	space to hold the returned  XmStringTable.   When  the
		 applicaiton  no  longer needs the returned XmStringTable, the
		 application should call XmStringFree once for	each  compound
		 string	 in  the  table, and then calling XtFree to deallocate
		 the XmStringTable itself.

RETURN
       Returns the number of compound strings in table.

RELATED
       XmStringTable(3).

						    XmStringToXmStringTable(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=XmStringToXmStringTable&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>

home | help