eant_AnnotationInfoReadWithOptions

Go Back

Summary:
  Read the input annotation to the ehfa file.

Header File:
  eant.h

Library Name:
  elib

Eant_AnnotationInfo*    eant_AnnotationInfoReadWithOptions  (
    Ehfa_File*    ehfaFile,
    char*    antNodePath,
    Eant_AnnotationInfo*    antInfo,
    Eerr_ErrorReport**    lclerr,
    ...    va_alist,
  )
antInfo
    Specifies the input annotation information.
antNodePath
    The node path and name.
ehfaFile
    The input ehfa file pointer.
lclerr
    Error handling structure pointer.
va_alist
    Variable Ehfa_FileOption arguments.

Description:
  Read the input annotation info from the input ehfa file node using the options passed in.

Notes:
  EANT_FILE_OPTION_FAST_IO - This option allows the annotation to be read using the faster method. This method assumes that the annotation elements have been written to the file sequentially and, therefore, requires that the data be written to a new file each time. If this options is on (EMSC_TRUE), eant_AnnotationInfoReadWithOptions will use the presence of the AnnotationVersionFlags node as a child of the antNodePath to further determine whether the fast reading method should be used for this data. This option takes one additional argument (Emsc_Boolean) indicating whether the fast I/O might be possible with the way this data is written to the file. By default fast I/O is on (EMSC_TRUE).

Return Description:
  Upon success this function returns a pointer to Eant_AnnotationInfo structure. If an error occurs, eant_AnnotationInfoReadWithOptions calls eerr_CreateErrorReport and returns the input antInfo.