DATASERV (kgeom) functions


LIBRARY ROUTINE

kgeom_write_header - write a geometry object header

LIBRARY CALL

int
kgeom_write_header(
   kgeom_object *object,
   char         *filename)

INPUT

OUTPUT

none

RETURN VALUE

TRUE on success, FALSE otherwise

DESCRIPTION

This function will write a header for a given geometry object and keep track of the open fid in the geometry object structure. This fid will be used for subsequent write calls for this geometry object.

In general, the kgeom_write_object() function should be used instead of this function. This function has been made public to provide complete flexibility for writing a geometry object. It should only be used when you wish to write a geometry object primitive-by-primitive. More information on this is available in the kgeom_write_primitive() man page.

A geometry object, when written to a file, will basically consist of a geometry header, geometry object data, and geometry primitive data. This routine allows you to write only the geometry header.

Functionally, the kgeom_write_object() routine is equivalent to a call to kgeom_write_header, followed by calls to kgeom_write_object_and_primitives() and kgeom_done_writing().

ADDITIONAL INFORMATION

none

EXAMPLES

none

SIDE EFFECTS

none

RESTRICTIONS

none

MODIFICATION

none

FILES

$DATASERV/objects/library/kgeom/src/object.c

SEE ALSO

kgeom(3), kgeom_write_object

COPYRIGHT

Copyright (C) 1993 - 1997, Khoral Research, Inc. ("KRI") All rights reserved.