qccdatasetwrite.3

spiht for linux this is used to decod and encode vedio i wich all enjoy

.TH QCCDATASETWRITE 3 "QCCPACK" ""
.SH NAME
QccDatasetWriteWholefile,
QccDatasetWriteHeader,
QccDatasetStartWrite,
QccDatasetEndWrite,
QccDatasetWriteBlock
\- writing of QccDataset structures to DAT-format files
.SH SYNOPSIS
.B #include "libQccPack.h"
.sp
.BI "int QccDatasetWriteWholefile(QccDataset *" dataset );
.br
.BI "int QccDatasetWriteHeader(QccDataset *" dataset );
.br
.BI "int QccDatasetStartWrite(QccDataset *" dataset );
.br
.BI "int QccDatasetEndWrite(QccDataset *" dataset );
.br
.BI "int QccDatasetWriteBlock(QccDataset *" dataset );
.SH DESCRIPTION
These routines implement the writing of
.B QccDataset
datasets to
.BR DAT -format
files.
There are two distinct modes in which the vector-array data
in datasets may be written:
the whole file may be written at once, or
the file may be written in non-overlapping blocks.
For each of these routines,
appropriate values must be supplied in
.IR dataset -> num_vectors ,
.IR dataset -> vector_dimension ,
.IR dataset -> min_val ,
and
.IR dataset -> max_val 
prior to calling the routines.
.LP
.B QccDatasetWriteWholefile()
writes the
.BR DAT -format
file whose filename is given by
.IR dataset -> filename .
The whole file, including the header and all vectors of the dataset,
is written at once.
.IR dataset -> vectors
is assumed to be allocated and to contain all
.I dataset -> num_vectors
vectors of the dataset.
.LP
.B QccDatasetWriteHeader()
writes header information to the
.BR DAT -format
file pointed to by
.IR dataset -> fileptr ,
which must be already open for writing
and positioned at the start of the file.
The magic number and version information is supplied
automatically by
.BR QccFileWriteMagicNumber (3).
.LP
.B QccDatasetStartWrite()
must be called before any block-based write to
.IR dataset .
.B QccDatasetStartWrite()
opens the file with 
.BR QccFileOpen (3)
and writes the file's header with
.BR QccDatasetWriteHeader (3).
If the vector array is not already allocated
(i.e., if
.IR dataset -> vectors
is
.BR NULL )
the vector array is allocated by calling
.BR QccDatasetAlloc (3).
Prior to calling
.BR QccDatasetStartWrite() ,
.IR dataset -> filename
must contain the name of the file,
.IR dataset -> vector_dimension
must give the dimension of the vectors,
.IR dataset -> num_vectors
must give the total number of vectors of the dataset,
and
.IR dataset -> access_block_size
must give the block size desired for subsequent block-based writes.
After
.B QccDatasetStartWrite()
returns,
.IR dataset -> fileptr
contains the
.B FILE
pointer to the open file, and the file
is positioned immediately after the header, ready for writing the
first block of vectors.
.LP
.B QccDatasetEndWrite()
closes a dataset file opened by a previous call to
.BR QccDatasetStartWrite() ;
additionally, the vector array,
.IR dataset -> vectors ,
is freed with a call to 
.BR QccDatasetFree (3).
.LP
.B QccDatasetWriteBlock()
writes the next block of vectors in the dataset.
.I dataset
must be prepared by a prior call to
.BR QccDatasetStartWrite() ;
that is, 
.IR dataset -> fileptr
must point to an open file
and
.IR dataset -> access_block_size
must contain the size of the block of vectors to write.
Additionally,
.IR dataset -> vectors
must contain the block of vectors to be written.
.B QccDatasetWriteBlock()
writes non-overlapping blocks of data to the file;
after
.B QccDatasetWriteBlock()
returns, the file is positioned to write the subsequent block.
.SH "RETURN VALUE"
These routines return 0 on successful completion, 1 if an error occurs
while writing the file.
.SH "SEE ALSO"
.BR QccDatasetRead (3),
.BR QccFileWriteMagicNumber (3),
.BR QccPack (3)
.SH AUTHOR
Copyright (C) 1997-2009  James E. Fowler
.\"  The programs herein are free software; you can redistribute them an.or
.\"  modify them under the terms of the GNU General Public License
.\"  as published by the Free Software Foundation; either version 2
.\"  of the License, or (at your option) any later version.
.\"  
.\"  These programs are distributed in the hope that they will be useful,
.\"  but WITHOUT ANY WARRANTY; without even the implied warranty of
.\"  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\"  GNU General Public License for more details.
.\"  
.\"  You should have received a copy of the GNU General Public License
.\"  along with these programs; if not, write to the Free Software
.\"  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.