Sync usage with man page.
[netbsd-mini2440.git] / usr.bin / make / lst.lib / lstClose.c
blobb0c1781702279f231e19cf13737b90320b1d38a8
1 /* $NetBSD: lstClose.c,v 1.10 2004/05/07 00:04:41 ross Exp $ */
3 /*
4 * Copyright (c) 1988, 1989, 1990, 1993
5 * The Regents of the University of California. All rights reserved.
7 * This code is derived from software contributed to Berkeley by
8 * Adam de Boor.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of the University nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * SUCH DAMAGE.
35 #ifndef MAKE_NATIVE
36 static char rcsid[] = "$NetBSD: lstClose.c,v 1.10 2004/05/07 00:04:41 ross Exp $";
37 #else
38 #include <sys/cdefs.h>
39 #ifndef lint
40 #if 0
41 static char sccsid[] = "@(#)lstClose.c 8.1 (Berkeley) 6/6/93";
42 #else
43 __RCSID("$NetBSD: lstClose.c,v 1.10 2004/05/07 00:04:41 ross Exp $");
44 #endif
45 #endif /* not lint */
46 #endif
48 /*-
49 * LstClose.c --
50 * Close a list for sequential access.
51 * The sequential functions access the list in a slightly different way.
52 * CurPtr points to their idea of the current node in the list and they
53 * access the list based on it. Because the list is circular, Lst_Next
54 * and Lst_Prev will go around the list forever. Lst_IsAtEnd must be
55 * used to determine when to stop.
58 #include "lstInt.h"
60 /*-
61 *-----------------------------------------------------------------------
62 * Lst_Close --
63 * Close a list which was opened for sequential access.
65 * Input:
66 * l The list to close
68 * Results:
69 * None.
71 * Side Effects:
72 * The list is closed.
74 *-----------------------------------------------------------------------
76 void
77 Lst_Close(Lst l)
79 List list = l;
81 if (LstValid(l) == TRUE) {
82 list->isOpen = FALSE;
83 list->atEnd = Unknown;