File: rarray_last.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 (38 lines) | stat: -rw-r--r-- 884 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

=head1 NAME

rarray_last, rarray_nth - return entries in a Roy Array.

=head1 SYNOPSIS

#include <roy.h>

void * rarray_last (RArray *I<array>);

void * rarray_nth (RArray *I<array>, unsigned int I<nth>);

=head1 DESCRIPTION

rarray_last(3) returns a pointer to the last entry in I<array>.
No entries are removed from the array during this operation.  It
is identical to rarray_peak(3).

rarray_nth(3) returns a pointer to the I<nth> entry in I<array>.

=head1 RETURN VALUE

These functions return pointers to entries in the array.  These
entries must then be cast to the appropriate types as defined when
created using rarray_new(3).

=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)