Request creation and execution
Description
Functions that create and execute a request to process a document
Functions |
| BFEXPORT_FUNCDEC int | BFOpenSecureRequest (BFHANDLE *request, BFHANDLE *errorinfo) |
| BFEXPORT_FUNCDEC int | BFExecuteSecureRequest (const BFHANDLE request, BFHANDLE *errorinfo) |
| BFEXPORT_FUNCDEC int | BFGetSecureResponse (const BFHANDLE request, BFHANDLE *response, BFHANDLE *errorinfo) |
| BFEXPORT_FUNCDEC int | BFCompareRequest (const BFHANDLE request1, const BFHANDLE request2, BFHANDLE *errorinfo) |
| BFEXPORT_FUNCDEC int | BFCloseSecureRequest (const BFHANDLE request, BFHANDLE *errorinfo) |
Function Documentation
| BFEXPORT_FUNCDEC int BFOpenSecureRequest |
( |
BFHANDLE * |
request, |
|
|
BFHANDLE * |
errorinfo | |
|
) |
| | |
Create a secure request. Creates a secure request that can be used to analyze and scrub documents. Secure requests can (and should) be reused within a single thread for processing multiple documents.
- Parameters:
-
| request | Pointer to a BFHANDLE that will represent the request |
| errorinfo | Pointer to a handle that will be set to an error information handle if the function's return value is not BFRESULT_OK. This parameter may be NULL and may be set to NULL if no error information is available. |
- Returns:
- One of the BFRESULT codes
| BFEXPORT_FUNCDEC int BFExecuteSecureRequest |
( |
const BFHANDLE |
request, |
|
|
BFHANDLE * |
errorinfo | |
|
) |
| | |
Execute a secure request. Executes a request to analyze or scrub a document. Use the BFSet*Option functions to setup the request before calling this function.
- Parameters:
-
| request | BFHANDLE that represents the request |
| errorinfo | Pointer to a handle that will be set to an error information handle if the function's return value is not BFRESULT_OK. This parameter may be NULL and may be set to NULL if no error information is available. |
- Returns:
- One of the BFRESULT codes
| BFEXPORT_FUNCDEC int BFGetSecureResponse |
( |
const BFHANDLE |
request, |
|
|
BFHANDLE * |
response, |
|
|
BFHANDLE * |
errorinfo | |
|
) |
| | |
Gets the response to a request. Used after a call to BFExecuteSecureRequest() to get the results.
- Parameters:
-
| request | BFHANDLE that represents the request |
| response | Pointer to a BFHANDLE that will represent the response |
| errorinfo | Pointer to a handle that will be set to an error information handle if the function's return value is not BFRESULT_OK. This parameter may be NULL and may be set to NULL if no error information is available. |
- Returns:
- One of the BFRESULT codes
| BFEXPORT_FUNCDEC int BFCompareRequest |
( |
const BFHANDLE |
request1, |
|
|
const BFHANDLE |
request2, |
|
|
BFHANDLE * |
errorinfo | |
|
) |
| | |
Compare two requests. This function is exposed primarily for testing purposes.
- Parameters:
-
| request1 | BFHANDLE that represents a request |
| request2 | BFHANDLE that represents a request |
| errorinfo | Pointer to a handle that will be set to an error information handle if the function's return value is not BFRESULT_OK. This parameter may be NULL and may be set to NULL if no error information is available. |
- Returns:
- BFTRUE if the requests contain all the same values, BFFALSE otherwise
| BFEXPORT_FUNCDEC int BFCloseSecureRequest |
( |
const BFHANDLE |
request, |
|
|
BFHANDLE * |
errorinfo | |
|
) |
| | |
Destory a secure request. The request should never again be used after this function returns.
- Parameters:
-
| request | BFHANDLE that represents the request |
| errorinfo | Pointer to a handle that will be set to an error information handle if the function's return value is not BFRESULT_OK. This parameter may be NULL and may be set to NULL if no error information is available. |
- Returns:
- One of the BFRESULT codes
