manpagez: man pages & more
man XmListGetMatchPos(3)
Home | html | info | man
XmListGetMatchPos(library call)                XmListGetMatchPos(library call)




NAME

       XmListGetMatchPos  --  A List function that returns all instances of an
       item in the list


SYNOPSIS

       #include <Xm/List.h>
       Boolean XmListGetMatchPos(
       Widget widget,
       XmString item,
       int **position_list,
       int *position_count);


DESCRIPTION

       XmListGetMatchPos is a Boolean function that returns an array of  posi-
       tions where a specified item is found in a List.

       widget    Specifies the ID of the List widget.

       item      Specifies the item to search for.

       position_list
                 Returns an array of positions at which the item occurs in the
                 List.  The position of the first item in the list is  1;  the
                 position of the second item is 2; and so on.  When the return
                 value is True, XmListGetMatchPos allocates  memory  for  this
                 array.   The  caller  is responsible for freeing this memory.
                 The caller  can  recover  the  allocated  memory  by  calling
                 XtFree.

       position_count
                 Returns the number of elements in the position_list.

       For  a  complete  definition  of List and its associated resources, see
       XmList(3).


RETURN

       Returns True if the specified item is present in the list, and False if
       it is not.


RELATED

       XmList(3).



                                               XmListGetMatchPos(library call)

openMotif 2.3.1 - Generated Mon Dec 1 06:24:47 CST 2008
© manpagez.com 2000-2025
Individual documents may contain additional copyright information.