Glasswall Document Processing Results

Each function returns status information on the last document processed by the library. No historical data is persisted.

These functions may be used once a document has been processed to elicit additional information on what processing was carried out on the document and, in the event of a document being identified as not conforming with its specification, the reason for non-conformance.

The eGwFileStatus enumeration is returned from all document processing functions to give an indication of the processing results. From this enumeration it can be established whether the document is 'managed' or not. A managed document may still have had changes made to it, the functions GWFileProcessMsg or GWFileProcessStatus can be used to identify the types of changes, if any, that have been carried out on the document.

In the event of a document processing function returning a status value indicating that the document was found to be non-conforming, the function GWFileErrorMsg can be used to return an explanatory line of text.

Modules

• Glasswall Return Status Definitions
• Process Status Bitmask Definitions

Functions

• wchar_t * GWFileProcessMsg (void)
• int GWFileProcessStatus (unsigned int *glasswallProcessStatus)
• wchar_t * GWFileErrorMsg (void)

GWFileProcessMsg

wchar_t* GWFileProcessMsg (void )

The file process message is a text representation of the status value detailed in GWFileProcessStatus.

Returns

• a pointer to a printable Null-terminated string

GWFileProcessStatus

int GWFileProcessStatus (unsigned int * glasswallProcessStatus)

This function retrieves the Glasswall Process Status. This status gives a high level indication of the processing that was carried out on the last document processed by the library.

The status value can be retrieved as a text string using the associated GWFileProcessMsg() function.

Parameters

Returns

• 1(Success) 0(Error)

GWFileErrorMsg

wchar_t* GWFileErrorMsg (void )

This function retrieves the Glasswall Process error message. If there are multiple reasons for document processing to return an error code only one shall be reported from this function. If more details on the process failures are required, the document can analysed to produce a detailed report on the contents of the document. All issues will be logged in the report.

Note that this string will be set to L"" if the Glasswall process has succeeded.

Returns

• a pointer to a printable Null-terminated string