UDF PROGRAMMERS MANUAL

start_image (1) UDF PROGRAMMERS MANUAL start_image (1)
NAME start_image

SYNOPSIS

#include "libbase_udf.h"
ByTe_2 start_image (u_ByTe_4 Key, ByTe_1 *Ext, u_ByTe_2 Ver, void *UDF);

INPUT DEFINITIONS

Key - UDF data key
Ext - UDF file extension
Ver - Version number
UDF - General data structure

DESCRIPTION start_image() is called immediately after the call to file_pos within a program to set the file pointer within the UDF file identified with Key and Ver to the start of an image. This routine can only be used on a UDF definition which has been defined in accordance with the UDF rules on how to identify images within a UDF data set.

Under this definition each image is composed of 1 or more columns of data which may be identified through one UDF vector sensor occurring in multiple sensor sets or multiple UDF vector sensors in one sensor set. Each sensor has associated with it a scan line number which runs from 0 to the number of columns defined in the image. This value must be the first of any sensor ancillary data sets defined for the sensors.

start_image() will set the current data pointer to the first sensor it finds whose scan line is set to 0. This includes the sensor which pointed to by the call to file_pos.

RETURN VALUE On success, ALL_OKAY is returned, otherwise an error code is returned.

ERRORS IMAGE_NOT_FOUND No opened file (file_open not called?) IMAGE_READ_ERROR Data read error EOF_STATUS No more data in data file IMAGE_HDR_MALLOC Error in mallocing memory for header data IMAGE_HDR_REALLOC Error in increasing memory for header data

APPLICABLE FORMATS UDF V2.2, IDFS V2.1

RESTRICTIONS None

SEE ALSO ret_codes(1H) file_open (1)

UDF V2.2 July 31, 1999 UDF V2.2

TOC HOME