CleanContent::SecureRequest Class Reference

Represents a request to perform an analysis, extraction and/or scrub of a document. More...

Inheritance diagram for CleanContent::SecureRequest:
CleanContent::OptionSet

List of all members.

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.

Detailed Description

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


Constructor & Destructor Documentation

CleanContent::SecureRequest::SecureRequest (  ) 

Creates a new SecureRequest object with all options set to their default values.


Member Function Documentation

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.

Returns:
True if the all the options in both requests have the same values
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.

Returns:
Object containing information about the source document

The documentation for this class was generated from the following file:
 All Classes Functions Variables Enumerations Properties
Clean Content .NET API 8.5.6.01.211123 documentation generated on Tue Nov 23 02:28:43 2021 by Doxygen 1.6.3