File: array_fail.3

package info (click to toggle)
libowfat 0.34-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 5,288 kB
  • sloc: ansic: 20,181; makefile: 16
file content (21 lines) | stat: -rw-r--r-- 509 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
.TH array_fail 3
.SH NAME
array_fail \- switch array to have failed
.SH SYNTAX
.B #include <libowfat/array.h>

void \fBarray_fail\fP(array* \fIx\fR);

  array \fIx\fR;
  array_fail(&\fIx\fR);

.SH DESCRIPTION
If \fIx\fR is allocated, array_fail frees the region that \fIx\fR points
to, and switches \fIx\fR to have failed.

If \fIx\fR is unallocated, array_fail simply switches \fIx\fR to have
failed.

If \fIx\fR has already failed, array_fail has no effect.
.SH "SEE ALSO"
array_allocate(3), array_reset(3)