Document Processing Arguments

This section describes the common arguments used in the document processing functions. The function argument naming is applied consistently across the API. An argument name prefixed with wc indicates that the function expects the argument to contain a wide character string.

Input Arguments

These arguments inform the process functions which file to process and the file type to expect.

inputFilePathName

The input file path for Glasswall processing. Glasswall ignores any file suffix, the file type must be specified in wcType.

wcType

Each of the processing functions requires the expected file type to be specified through the wcType argument. The following table details the expected values for wcType.

The values for wcType are case-sensitive.

File to Memory Location Output Arguments

These arguments are used to return process information from the Glasswall library when using the File to Memory Locations process functions.

Client applications do not need to manage the release of memory allocated to these return buffers.

outputFileBuffer

The Glasswall processing output file buffer.

This buffer contains an image of the Glasswall processed output file which will be of the same data type as the input file and will have managed content removed and Glasswall protected according to the standard content specification allowed for the file data type.

The argument can be set to NULL when the outputFileBuffer is not required and only validation of a file is required. In this case then the ref gwOutputLength "outputLength" argument should also be set to NULL.

outputLength

Length of the outputFileBuffer.

The argument can be set to NULL when the outputFileBuffer is not required and only validation of a file required. In this case then the outputFileBuffer should also be set to NULL.

analysisFileBuffer

Analysis (XML) file buffer from Glasswall processing. This buffer contains an image of the Glasswall ANALYSIS report of the specified file.

analysisFileBufferLength

Length of the analysisFileBuffer

reportFileBuffer

Detailed log file buffer from Glasswall processing. The argument can be set to NULL when the report is not required.

In this case then the reportFileBufferLength should also be set to NULL.

reportFileBufferLength

Length of the reportFileBuffer that has been allocated. The argument can be set to NULL when the report is not required.

In this case then the reportFileBuffer should also be set to NULL.

File to File Output Arguments

These arguments are used to return process information from the Glasswall library when using the File to File process functions.

Destination folders for these files must exist and be writable, processing will be reported in error if these conditions are not met.

outputFilePathName

Destination for the managed file from Glasswall processing.

This file contains the Glasswall processed output file which will be of the same type as the input file, will have managed content removed and be Glasswall protected according to the standard content specification allowed for the file type.

analysisFilePathName

Destination for Analysis Audit report (XML) from Glasswall processing. This file contains an image of the Glasswall ANALYSIS of the processed file.

reportFilePathName

Destination for detailed processing log file buffer from Glasswall processing.

exportFilePathName

Destination for the exported zip archive. This zip archive containing the Managed file, the Analysis report, and extracted elements such as images and text.

Determine File Type Output Enumeration

File Type Enumeration

The following table details the possible enumeration values that can be returned with a call to GWDetermineFileTypeFromFile and what they represent.

The following table is an extension to the table above and indicates issues that may occur during interrogation.

Process Return Status

All the processing functions return values as defined in eGwFileStatus.