_ntar_section_handle Struct Reference

#include <ntar_int.h>

Detailed Description

This structure represents the root block for a file. It corresponds to a Section Header Block of the draft, see 3.1.
Examples:

test001.c, test002.c, test003.c, test004.c, test005.c, test006.c, test007.c, test008.c, test009.c, test010.c, test011.c, test012.c, test013.c, test014.c, test015.c, test016.c, test017.c, and test018.c.


Data Fields

ntar_file_handlers file_handlers
ntar_foff block_start
block_header bh
section_header_block shb
ntar_option * options
_ntar_file_handle * file_handle
int byte_order
ntar_block_handle cache_block
int block_opened
int header_written
u_int32 shb_header_length
ntar_read_iterator read_iterator
char * options_buffer
size_t options_buffer_length
char * raw_options_buffer
size_t raw_options_buffer_length
int reached_end_of_section

Field Documentation

block_header _ntar_section_handle::bh
 

The block header of this section, as written on file. This field is valid in read mode only, and it contains data in host byte order

int _ntar_section_handle::block_opened
 

TRUE if the cache block is opened

ntar_foff _ntar_section_handle::block_start
 

Position in the file where the section/block begins.

int _ntar_section_handle::byte_order
 

Byte order for this section. Possible values are

  • HOST_BYTE_ORDER
  • SWAPPED_HOST_BYTE_ORDER This field is valid in read mode only.

ntar_block_handle _ntar_section_handle::cache_block
 

Handle to a block handle cache.

struct _ntar_file_handle* _ntar_section_handle::file_handle
 

Handle to the ntar file containing this section

ntar_file_handlers _ntar_section_handle::file_handlers
 

General information about the underlying file.

int _ntar_section_handle::header_written
 

TRUE if the block header has been closed. This field is valid in read mode only.

ntar_option* _ntar_section_handle::options
 

Linked list of the options that will be written to file, or that have been read from file. The linked list does NOT contain the trailing END OPTION.

char* _ntar_section_handle::options_buffer
 

Pointer to a temp buffer used to read the options.

size_t _ntar_section_handle::options_buffer_length
 

Length of the options_buffer

char* _ntar_section_handle::raw_options_buffer
 

size_t _ntar_section_handle::raw_options_buffer_length
 

int _ntar_section_handle::reached_end_of_section
 

ntar_read_iterator _ntar_section_handle::read_iterator
 

Indexes of the current, previous and next block in the section.

section_header_block _ntar_section_handle::shb
 

The section header block that will be written to file or that has been read from file. This field is always written in host byte order.

u_int32 _ntar_section_handle::shb_header_length
 

Length of the Section Header Block, excluding the heading/trailing generic block header This field is valid in read mode only.

The documentation for this struct was generated from the following file:

NTAR documentation. Copyright (c) 2004 - 2005 Condor Engineering, Inc. All rights reserved.