Crewes Seismic I/O Library File Index. Function Documentation. Functions to access seimic header definitions, страница 9

hdr   file header destination (should be allocated, length=FILE_HDR_LENGTH)

int seisioFileHdr_getI2 (int id, const char * hdrName, int16 * hdrValue)

Get a value 2-byte (16 bit) integer value from the header.

Returns non-zero on failure (see seisio.h for error definitions). Get fails if the corresponding data type is not defined in the seismic header definition  at the requested byte.

Parameters:

id   identification number of the seismic file header instance to access

hdrName   name of the header to access

hdrValue   output argument for value of the header

int seisioFileHdr_getI2ByByte (int id, int byt, int16 * hdrValue)

Get a value 2-byte (16 bit) integer value from the header given a starting byte location.

Returns non-zero on failure (see seisio.h for error definitions). Get fails if the corresponding data type is not defined in the seismic header definition  at the requested byte.

Parameters:

id   identification number of the seismic file header instance to access

byt   byte number in file header from which the value should be retrieved. Starts at 0.

hdrValue   output argument for value of the header

int seisioFileHdr_getI4 (int id, const char * hdrName, int32 * hdrValue)

Get a value 4-byte (32 bit) integer value from the header.

Returns non-zero on failure (see seisio.h for error definitions). Get fails if the corresponding data type is not defined in the seismic header definition  at the requested byte.

Parameters:

id   identification number of the seismic file header instance to access

hdrName   name of the header to access

hdrValue   output argument for value of the header

int seisioFileHdr_getI4ByByte (int id, int byt, int32 * hdrValue)

Get a value 4-byte (32 bit) integer value from the header given a starting byte location.

Returns non-zero on failure (see seisio.h for error definitions). Get fails if the corresponding data type is not defined in the seismic header definition  at the requested byte.

Parameters:

id   identification number of the seismic file header instance to access

byt   byte number in file header from which the value should be retrieved. Starts at 0.

hdrValue   output argument for value of the header

char * seisioFileHdr_getInternalData (int id)

Gets a pointer to the data segment of the file header.

Returns:

a pointer to the data segment of the file header. Returns null if id is invalid.

Parameters:

id   identification number of the seismic file header instance to access

char * seisioFileHdr_getInternalText (int id)

Gets the text segment of the file header.

Returns a pointer to the text segment of the file header. Returns null if id is invalid.

Parameters:

id   identification number of the seismic file header instance to access

int seisioFileHdr_getText (int id, char * fileHdrStr)

Returns the text segment of the file header as an array of chars.

fileHdrStr length must be at least 3200. Output contains actual 3200 header formatted in ASCII.

Parameters:

id   identification number of the seismic file header instance to access

fileHdrStr   string of characters to store the text segment in

int seisioFileHdr_new (int seisioHdrDefnID)

Creates a new seismic file header object instance.

Returns id of new seismic file header object.

Parameters:

seisioHdrDefnID   identification number of an open seimic header defnition instance

int seisioFileHdr_putF4 (int id, const char * hdrName, float hdrValue)

See also:

seisioFileHdr_putI2() (p.pagenum)

int seisioFileHdr_putI2 (int id, const char * hdrName, int16 hdrValue)

Put a value (int16, int32 or float) into the data segment.

Returns non-zero on failure (see seisio.h for error definitions). Put fails if the corresponding data type is not defined in the seismic header definition at the requested byte.

Parameters:

id   identification number of the seismic file header instance to access

hdrName   name of the header to access