1\" Generated by c2man from bl_sam_buff_set_previous_pos.c
2.TH bl_sam_buff_set_previous_pos 3
3
4.SH LIBRARY
5\" Indicate #includes, library name, -L and -l flags
6.nf
7.na
8#include <biolibc/sam-buff.h>
9-lbiolibc -lxtend
10.ad
11.fi
12
13\" Convention:
14\" Underline anything that is typed verbatim - commands, etc.
15.SH SYNOPSIS
16.PP
17.nf
18.na
19int     bl_sam_buff_set_previous_pos(bl_sam_buff_t *bl_sam_buff_ptr, uint64_t new_previous_pos)
20.ad
21.fi
22
23.SH ARGUMENTS
24.nf
25.na
26bl_sam_buff_ptr Pointer to the structure to set
27new_previous_pos The new value for previous_pos
28.ad
29.fi
30
31.SH DESCRIPTION
32
33Mutator for previous_pos member in a bl_sam_buff_t structure.
34Use this function to set previous_pos in a bl_sam_buff_t variable
35from non-member functions.  This function performs a direct
36assignment for scalar or pointer structure members.  If
37previous_pos is a pointer, data previously pointed to should
38generally be freed before calling this function to avoid memory
39leaks.
40
41Note that there is an equivalent macro (), which performs
42this function with no data verification or function call overhead.
43Use the macro version to maximize performance where the validity
44of new_previous_pos is guaranteed by other means.
45
46.SH EXAMPLES
47.nf
48.na
49
50bl_sam_buff_t   bl_sam_buff;
51uint64_t        new_previous_pos;
52
53if ( bl_sam_buff_set_previous_pos(&bl_sam_buff, new_previous_pos) == BL_DATA_OK )
54{
55}
56.ad
57.fi
58
59.SH SEE ALSO
60
61(3)
62
63