Microline/man/XmLArrayNew.3x

   1 .\" ***** BEGIN LICENSE BLOCK *****
   2 .\" Version: MPL 1.1/GPL 2.0/LGPL 2.1
   3 .\"
   4 .\" The contents of this file are subject to the Mozilla Public License Version
   5 .\" 1.1 (the "License"); you may not use this file except in compliance with
   6 .\" the License. You may obtain a copy of the License at
   7 .\" http://www.mozilla.org/MPL/
   8 .\"
   9 .\" Software distributed under the License is distributed on an "AS IS" basis,
  10 .\" WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11 .\" for the specific language governing rights and limitations under the
  12 .\" License.
  13 .\"
  14 .\" The Original Code is the Microline Widget Library, originally made available under the NPL by Neuron Data <http://www.neurondata.com>.
  15 .\"
  16 .\" The Initial Developer of the Original Code is
  17 .\" Netscape Communications Corporation.
  18 .\" Portions created by the Initial Developer are Copyright (C) 1998
  19 .\" the Initial Developer. All Rights Reserved.
  20 .\"
  21 .\" Contributor(s):
  22 .\"
  23 .\" Alternatively, the contents of this file may be used under the terms of
  24 .\" either the GNU General Public License Version 2 or later (the "GPL"), or
  25 .\" the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  26 .\" in which case the provisions of the GPL or the LGPL are applicable instead
  27 .\" of those above. If you wish to allow use of your version of this file only
  28 .\" under the terms of either the GPL or the LGPL, and not to allow others to
  29 .\" use your version of this file under the terms of the MPL, indicate your
  30 .\" decision by deleting the provisions above and replace them with the notice
  31 .\" and other provisions required by the GPL or the LGPL. If you do not delete
  32 .\" the provisions above, a recipient may use your version of this file under
  33 .\" the terms of any one of the MPL, the GPL or the LGPL.
  34 .\"
  35 .\" In addition, as a special exception to the GNU GPL, the copyright holders
  36 .\" give permission to link the code of this program with the Motif and Open
  37 .\" Motif libraries (or with modified versions of these that use the same
  38 .\" license), and distribute linked combinations including the two. You
  39 .\" must obey the GNU General Public License in all respects for all of
  40 .\" the code used other than linking with Motif/Open Motif. If you modify
  41 .\" this file, you may extend this exception to your version of the file,
  42 .\" but you are not obligated to do so. If you do not wish to do so,
  43 .\" delete this exception statement from your version.
  44 .\"
  45 .\" ***** END LICENSE BLOCK *****
  46 .TH XmLArrayNew 3X "R1" "XML1" "XML"
  47 .SH NAME
  48 XmLArrayNew \- creates an array object
  49 .SH SYNTAX
  50 XmLArray XmLArrayNew(\fIautonumber\fP, \fIgrowFast\fP)
  51 .br
  52 char \fIautonumber\fP;
  53 .br
  54 char \fIgrowFast\fP;
  55 .LP
  56 .SH ARGUMENTS
  57 .IP \fIautonumber\fP 1i
  58 If set to 1, the pointers in the array are assumed to be
  59 pointers to structures containing an integer as the first
  60 element which will be set to the position of the item
  61 in the array. The array will set this value with the
  62 current position of the element whenever position
  63 of the item changes.  If set to 0, the array will never
  64 dereference the pointers contained in the array.
  65 .IP \fIgrowFast\fP 1i
  66 If set to 1, the array will grow quickly as items are added
  67 to it.  This will cause the amount of memory the array takes
  68 up to usually be greater than the current space for elements.
  69 If set to 0, the array will always be the size of the current
  70 space for the elements contained in the array.
  71 .SH DESCRIPTION
  72 Creates an array object and returns it.  An array object is used to
  73 hold an array of pointers.  This object should be freed with XmLArrayFree()
  74 when it is no longer used.
  75 .SH RETURN VALUE
  76 The newly allocate array object.
  77 .SH "SEE ALSO"
  78 XmLArrayAdd(3X) XmLArrayDel(3X) XmLArrayFree(3X) XmLArrayGet(3X)
  79 XmLArrayGetCount(3X) XmLArrayMove(3X)
  80 XmLArrayReorder(3X) XmLArraySet(3X) XmLArraySort(3X)