Mercurial > repos > dawe > srf2fastq
comparison srf2fastq/io_lib-1.12.2/man/man3/write_scf.3 @ 0:d901c9f41a6a default tip
Migrated tool version 1.0.1 from old tool shed archive to new tool shed repository
author | dawe |
---|---|
date | Tue, 07 Jun 2011 17:48:05 -0400 |
parents | |
children |
comparison
equal
deleted
inserted
replaced
-1:000000000000 | 0:d901c9f41a6a |
---|---|
1 .TH write_scf 3 "" "" "Staden Package" | |
2 | |
3 .SH NAME | |
4 | |
5 .LP | |
6 .BR write_scf , | |
7 .BR fwrite_scf , | |
8 .BR write_scf_header | |
9 \- Write SCF files | |
10 | |
11 .SH SYNOPSIS | |
12 .LP | |
13 .nf | |
14 .ft B | |
15 #include <scf.h> | |
16 .ft | |
17 .fi | |
18 .LP | |
19 .nf | |
20 .ft B | |
21 int write_scf( | |
22 Scf *scf, | |
23 char *fn); | |
24 .ft | |
25 .fi | |
26 .LP | |
27 .nf | |
28 .ft B | |
29 int fwrite_scf( | |
30 Scf *scf, | |
31 FILE *fp); | |
32 .ft | |
33 .fi | |
34 .LP | |
35 .nf | |
36 .ft B | |
37 int write_scf_header( | |
38 FILE *fp, | |
39 Header *h); | |
40 .ft | |
41 .fi | |
42 .IX "write_scf()" "" "write_scf()" | |
43 .IX "fwrite_scf()" "" "fwrite_scf()" | |
44 .IX "write_scf_header()" "" "write_scf_header()" | |
45 | |
46 .SH DESCRIPTION | |
47 .LP | |
48 These functions write SCF format trace files. All the functions accepting a | |
49 \fBFILE *\fP as an argument assume that the file pointer is at the correct | |
50 offset within the file, which should be the start. | |
51 .LP | |
52 .B write_scf() | |
53 writes an entire SCF file into the \fBScf\fR structure (see the | |
54 .BR scf (4) | |
55 manual page for the details of this structure). The data is written to the | |
56 specified file name. | |
57 .LP | |
58 .B fwrite_scf() | |
59 writesan entire SCF file into the \fBScf\fR structure (see the | |
60 .BR scf (4) | |
61 manual page for the details of this structure). The data is written to the | |
62 specified file pointer, which is neither closed or rewound after the | |
63 operation. | |
64 .LP | |
65 .B write_scf_header() | |
66 writes the \fBHeader\fR structure to the specified file pointer. | |
67 | |
68 .SH RETURN VALUES | |
69 .LP | |
70 On successful completion, the \fBwrite_scf()\fR, \fBfwrite_scf()\fR and | |
71 \fBwrite_scf_header()\fR functions return 0. Otherwise these function returns | |
72 -1. | |
73 | |
74 .SH SEE ALSO | |
75 .LP | |
76 .BR scf (4), | |
77 .BR read_scf (3) |