_ntar_block_handle Struct Reference

#include <ntar_int.h>

Detailed Description

This structure represents a generic block contained in a section.
Examples:

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


Data Fields

ntar_file_handlers file_handlers
int byte_order
ntar_foff block_start
_ntar_section_handle * section_handle
void * plugin_state
ntar_option * options
_ntar_plugin_data * plugin_data
block_header bh
int are_block_data_read
char * options_buffer
size_t options_buffer_length
size_t data_buffer_length
char * data_buffer
void * block_data
void * raw_data_buffer
size_t raw_data_buffer_length
size_t raw_data_buffer_start_options

Field Documentation

int _ntar_block_handle::are_block_data_read
 

TRUE if the fixed block data (i.e. the content of the block excluding the options) has been read

block_header _ntar_block_handle::bh
 

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

void* _ntar_block_handle::block_data
 

ntar_foff _ntar_block_handle::block_start
 

Position in the file where the section/block begins.

int _ntar_block_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.

char* _ntar_block_handle::data_buffer
 

Pointer to a temp buffer used to read/write the data.

size_t _ntar_block_handle::data_buffer_length
 

Length of the data_buffer

ntar_file_handlers _ntar_block_handle::file_handlers
 

General information about the underlying file.

ntar_option* _ntar_block_handle::options
 

char* _ntar_block_handle::options_buffer
 

Pointer to a temp buffer used to read/write the options.

size_t _ntar_block_handle::options_buffer_length
 

Length of the options_buffer

struct _ntar_plugin_data* _ntar_block_handle::plugin_data
 

A opaque handle to the plugin used to manage this block.

void* _ntar_block_handle::plugin_state
 

Pointer to data used by the plugin. TODO currently not in use.

void* _ntar_block_handle::raw_data_buffer
 

size_t _ntar_block_handle::raw_data_buffer_length
 

size_t _ntar_block_handle::raw_data_buffer_start_options
 

struct _ntar_section_handle* _ntar_block_handle::section_handle
 

Handle to the section containing this block

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

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