File: rarray_len.pod

package info (click to toggle)
roy 1.0.2-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 2,072 kB
  • ctags: 776
  • sloc: sh: 7,068; ansic: 6,292; makefile: 248
file content (41 lines) | stat: -rw-r--r-- 1,063 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

=head1 NAME

rarray_len, rarray_set_len - get/set array length.

=head1 SYNOPSIS

#include <roy.h>

unsigned int rarray_len (RArray *I<array>);

void rarray_set_len (RArray *I<array>, unsigned int I<len>);

=head1 DESCRIPTION

rarray_len(3) returns the number of entries in the array I<array>.

rarray_set_len(3) sets the number of entries in the array to
I<len>.  If len is greater than the current number, the current
entry is advanced to that position, but none of the entries over which
it had to skip to get there are changed.  If more blocks are required
(see rarray_new(3)), then they are created as needed.  If the rarray
is to be shrunken, the current entry pointer is merely moved back.

=head1 RETURN VALUE

rarray_len(3) returns the number of entries in the array.

rarray_set_len(3) returns no value.

=head1 ERRORS

These calls produce no errors.

=head1 SEE ALSO

rarray(3), rarray_append(3), rarray_free(3), 
rarray_last(3), rarray_len(3), rarray_new(3), 
rarray_nth(3), rarray_peak(3), rarray_pop(3), 
rarray_push(3), rarray_set_len(3), roy(3)