Represents a request to perform an analysis, extraction and/or scrub of a document. More...
Public Member Functions | |
void | Close () |
Must be called once for each SecureRequest. | |
bool | Compare (SecureRequest other) |
Compares the settings in this request with the settings in another request. | |
void | Execute () |
Executes the request. | |
SecureResponse | GetResponse () |
Gets the response to the most recently executed request. | |
SecureRequest () | |
Creates a new SecureRequest object with all options set to their default values. |
Represents a request to perform an analysis, extraction and/or scrub of a document.
This class is an application's primary interface to Clean Content. See the Clean Content Developer Guide for details on exceptions, object life-cycle, threading, general information and examples of using this class
CleanContent::SecureRequest::SecureRequest | ( | ) |
Creates a new SecureRequest object with all options set to their default values.
void CleanContent::SecureRequest::Close | ( | ) |
Must be called once for each SecureRequest.
Frees non-CLR memory and objects associated with the SecureRequest. This call is necessary because the non-CLR memory and objects must be freed in the same thread in which the SecureRequest was created. This cannot be acomplished in a finalizer because finalizers are not gaurenteed to run the same thread in which the object was created and very often don't.
bool CleanContent::SecureRequest::Compare | ( | SecureRequest | other | ) |
Compares the settings in this request with the settings in another request.
void CleanContent::SecureRequest::Execute | ( | ) |
Executes the request.
This method will not return until the analysis/scrub/extraction/export has been completed. Results can be retrieved by calling the GetResponse method.
SecureResponse CleanContent::SecureRequest::GetResponse | ( | ) |
Gets the response to the most recently executed request.