File: array_length.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 (20 lines) | stat: -rw-r--r-- 648 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
.TH array_length 3
.SH NAME
array_length \- get number of allocated members in array
.SH SYNTAX
.B #include <libowfat/array.h>

int64 \fBarray_length\fP(array* \fIx\fR,uint64 \fImembersize\fR);

  array \fIx\fR;
  int64 members = array_length(&\fIx\fR,sizeof(\fIt\fR));

.SH DESCRIPTION
array_length returns the number of initialized bytes in \fIx\fR, divided
by the size of \fIt\fR. In other words, array_get will succeed for
positions 0 through array_length-1; it will fail for position
array_length.

If \fIx\fR is unallocated, array_length and array_bytes return 0.
.SH "SEE ALSO"
array_allocate(3), array_get(3), array_fail(3), array_bytes(3)