7. Unrecognized Data - UnrecognizedData

The UnrecognizedData module allows to query lines with unrecognized keywords or cards in Library Devices. This object can provide the number of lines with unrecognized data, the line numbers, and the lines themselves. It is accessed via the method vdm_LManGetObject() with the VDM_UNRECOGNIZEDDATA object type. Currently, the following Library Devices are supported:

The methods associated with a UnrecognizedData object are the following.

Instance a UnrecognizedData object using vdm_UnrecognizedDataBegin().

7.1. Function Descriptions

The currently available UnrecognizedData functions are described in detail in this section.

vdm_UnrecognizedData *vdm_UnrecognizedDataBegin(void)

create an instance of an UnrecognizedData object

Create an instance of a UnrecognizedData object. Memory is allocated for the object private data and the pointer to the data is returned.

Destroy an instance of a UnrecognizedData object using 

void vdm_UnrecognizedDataEnd (vdm_UnrecognizedData *metric)

Returns:

The function returns a pointer to the newly created UnrecognizedData object. If the object creation fails, NULL is returned.

void vdm_UnrecognizedDataAddLine(vdm_UnrecognizedData *p, Vint lineNumber, Vchar line[])

add a line of unrecognized data to the UnrecognizedData object

Add a line of unrecognized data to the UnrecognizedData object. The line number and the line are stored in the object.

Parameters:

  • p – pointer to the UnrecognizedData object

  • lineNumber – line number of the unrecognized data

  • line – the unrecognized data

void vdm_UnrecognizedDataInq(vdm_UnrecognizedData *p, Vint *count)

get the number of lines of unrecognized data

Parameters:

  • p – pointer to the UnrecognizedData object

  • count – [out] the number of lines of unrecognized data

void vdm_UnrecognizedDataGetLineNumbers(vdm_UnrecognizedData *p, vsy_IntVec **lineNumbers)

get the line numbers of the unrecognized data

Parameters:

  • p – pointer to the UnrecognizedData object

  • lineNumbers – [out] the line numbers of the unrecognized data

void vdm_UnrecognizedDataGetLines(vdm_UnrecognizedData *p, vsy_HashTable **lines)

get the lines of the unrecognized data

Parameters:

  • p – pointer to the UnrecognizedData object

  • lines – [out] the lines of the unrecognized data

void vdm_UnrecognizedDataEnd(vdm_UnrecognizedData *p)

destroy an instance of a UnrecognizedData object

See vdm_UnrecognizedDataBegin()