ltabb 8ed5afe62c Free the lizard
git-svn-id: svn://10.0.0.236/trunk@10 18797224-902f-48f8-a5cc-f745e15eee43
1998-03-28 02:44:41 +00:00

61 lines
2.0 KiB
Plaintext

.\" The contents of this file are subject to the Netscape Public License
.\" Version 1.0 (the "NPL"); you may not use this file except in
.\" compliance with the NPL. You may obtain a copy of the NPL at
.\" http://www.mozilla.org/NPL/
.\"
.\" Software distributed under the NPL is distributed on an "AS IS" basis,
.\" WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
.\" for the specific language governing rights and limitations under the
.\" NPL.
.\"
.\" The Initial Developer of this code under the NPL is Netscape
.\" Communications Corporation. Portions created by Netscape are
.\" Copyright (C) 1998 Netscape Communications Corporation. All Rights
.\" Reserved.
.\"
.\"
.\"
.\"
.\" The following source code is part of the Microline Widget Library.
.\" The Microline widget library is made available to Mozilla developers
.\" under the Netscape Public License (NPL) by Neuron Data. To learn
.\" more about Neuron Data, please visit the Neuron Data Home Page at
.\" http://www.neurondata.com.
.\"
.\"
.TH XmLArrayMove 3X "R1" "XML1" "XML"
.SH NAME
XmLArrayMove \- move items in an array
.SH SYNTAX
int XmLArrayMove(\fIarray\fP, \fInewPos\fP, \fIpos\fP, \fIcount\fP)
.br
XmLArray \fIarray\fP;
.br
int \fInewPos\fP;
.br
int \fIpos\fP;
.br
int \fIcount\fP;
.LP
.SH ARGUMENTS
.IP \fIarray\fP 1i
array to operate on
.IP \fInewPos\fP 1i
position to move to
.IP \fIpos\fP 1i
position to move from
.IP \fIcount\fP 1i
number of items to move
.SH DESCRIPTION
Moves \fIcount\fP pointers starting at position \fIpos\fP in the
\fIarray\fP to the new position \fInewPos\fP. The existing pointers
at the new location are moved down to accommodate the move. No pointers
are overwritten by this call and the size of the array will remain
unchanged.
.SH RETURN VALUE
0 upon success and -1 upon failure (a value passed is out of range).
.SH "SEE ALSO"
XmLArrayAdd(3X) XmLArrayDel(3X) XmLArrayFree(3X) XmLArrayGet(3X)
XmLArrayGetCount(3X) XmLArrayNew(3X)
XmLArrayReorder(3X) XmLArraySet(3X) XmLArraySort(3X)