Functions that set and get the options on a request
| #define BFTRUE 1 |
Integer representing true
| #define BFFALSE 0 |
Integer representing false
| #define BFCHANNELCANREAD 0x0001 |
The channel can read bytes from the file. Used in return value from BFChannelSupports().
| #define BFCHANNELCANWRITE 0x0002 |
The channel can write bytes to the file. Used in return value from BFChannelSupports().
| typedef long(* BFChannelRead)(void *channel, void *buffer, BFINT32 count, BFINT64 position) |
Pointer to a function that reads bytes from the channel.
| channel | A pointer back to the BFCHANNEL structure provided in BFSetFileOptionUsingChannel. | |
| buffer | The buffer to read bytes into | |
| count | Number of bytes to read | |
| position | Offset in the file the bytes should be read at |
| typedef void(* BFChannelWrite)(void *channel, void *buffer, BFINT32 count, BFINT64 position) |
Pointer to a function that writes bytes to the channel.
| channel | A pointer back to the BFCHANNEL structure provided in BFSetFileOptionUsingChannel. | |
| buffer | The buffer containing the bytes to write | |
| count | Number of bytes to write | |
| position | Offset in the file the bytes should be written to |
| typedef BFINT64(* BFChannelSize)(void *channel) |
Pointer to a function that provides the size of the channel.
| channel | A pointer back to the BFCHANNEL structure provided in BFSetFileOptionUsingChannel. |
| typedef long(* BFChannelSupports)(void *channel) |
Pointer to a function that returns information about what features this channel supports.
| channel | A pointer back to the BFCHANNEL structure provided in BFSetFileOptionUsingChannel. |
| typedef void(* BFChannelClose)(void *channel) |
Pointer to a function that closes the channel.
| channel | A pointer back to the BFCHANNEL structure provided in BFSetFileOptionUsingChannel. |
| typedef void(* BFChannelTruncate)(void *channel, BFINT64 size) |
Pointer to a function that truncates the channel to the given size.
| channel | A pointer back to the BFCHANNEL structure provided in BFSetFileOptionUsingChannel. | |
| size | Size of the file after truncation |
| enum BooleanOptions |
Options representing a TRUE or FALSE value. Used with BFSetBooleanOption(), BFGetBooleanOption() and BFGetBooleanResult().
| SecureOptions_WasIdentified |
The source document was identified The source document was identified. Default value is BFFALSE |
| SecureOptions_WasSupported |
The source document's file format is supported The source document's file format is supported and processing was attempted. Default value is BFFALSE |
| SecureOptions_WasProcessed |
The source document was scrubbed, analyzed or extracted The source document was scrubbed, analyzed or extracted. Will be set to false if no component could be found to process the source document. Default value is BFFALSE |
| SecureOptions_WasException |
An exception occured while processing the document An exception occured while processing the document. This is somewhat redundant since the developer will receive the exception itself but is included so the SecureResult can stand alone to completely describe the result of processing a document. Default value is BFFALSE |
| SecureOptions_WasTimeout |
Document took long than the request's RequestTimeout value to process The document took long than the request's RequestTimeout value to process or was interrupted. Default value is BFFALSE |
| SecureOptions_LoggedError |
An error occured and was logged while processing the document An error occured and was logged while processing the document. Errors include exceptions that end processing (WasException will also be true) and other conditions that don't cause exceptions but may lead major loss of functionallity. See the log for details. Default value is BFFALSE |
| SecureOptions_LoggedWarning |
A warning occured and was logged while processing the document A warning occured and was logged while processing the document. Warnings include conditions that may lead to small losses of functionallity. See log for details. Default value is BFFALSE |
| SecureOptions_TimeoutUsingThreadStop |
If set to 'true', requests in tight infinite loops will be stopped using the depricated Thread.stop method When a malformed document pushes Clean Content into an infinite loop, a monitoring thread attempts to interrupt the thread after a certain timeout period given by the RequestTimeout option. One of two things will then occur: 1) if the request is in a loop that can be interrupted then the request will be stopped and the SecureRequest execute method will return, 2) if in the very rare case the request is in a tight loop and this option is set to 'true' the monitoring thread will use the depricate Thread.stop method to kill the thread. Anyone setting this option to 'true' must understand the implications of having the Java thread running the request destroyed. See the Java API documentation for java.lang.Thread for details. Default value is BFFALSE |
| SecureOptions_JustIdentify |
Ignore all other settings and just identify the file format of the source document When this option is true the only action that will be taken is to identify the file format of the source document. Default value is BFFALSE |
| SecureOptions_TransformResult |
Perform an XML transform on the result document If set to truethe contents of the XML result will be XSLT processed using the document specificed in the ResultTransform option before being written. This option is valid only when OutputType is set to TOXML. Default value is BFFALSE |
| SecureOptions_PropertiesOnly |
Extract only properties from the document Extract only properties from the document while skipping the body text and structure. Default value is BFFALSE |
| SecureOptions_ExportReplace |
The exported document should be replaced When this option is set to true the ExportReplacementDocument and ExportReplacementFormat options are used to replace the exported document. Commonly used to replace embeddings. Default value is BFFALSE |
| SecureOptions_GenerateAcrobatHighlightPositions |
Generate the character highlight positions associated with the start of each word when extracting from PDF documents. This option enables the extraction of character highlight positions at the start of each word when extracting from PDF documents. This information can be used to create an Adobe highlight file for the purpose of highlighting select text when viewing the original PDF document in Acrobat. The details of the Adobe Highlight file format can be found in the Adobe technical note titled HighlightFileFormat.pdf, availabe from Adobe. The highlight positions are provided by the PdfHL element in the extracted XML. These positions are character positions as defined in the Adobe technical note. Note that the Adobe character counting algorithm does not necessarily increment by 1 for each subsequent character. However, Acrobat highlights on full word boundaries even when a partial range is provided. For this reason it is reasonable to highlight select words by providing the position and a length equal to 1 or the number of characters to highlight. Default value is BFFALSE |
| SecureOptions_FilterHyphensAtEndOfLine |
Detect and remove soft and hard hyphens found at the end of a line. This option enables the detection and removal of soft and hard hyphens found at the end of a line during the extraction process. It is not uncommon for applications that generate PDF to use either a soft or hard hyphen to hyphenate a word when wrapping from one line to another. This feature is dependent on Clean Content's ability to infer line boundaries since they are not stored within a PDF document. Lines are inferred by monitoring position changes during text operations. It would be ideal to only remove soft hyphens during this process but unfortunately many application use hard hyphens for hyphenation when generating the PDF document. Use of this feature can result in the removal of legitimate hard hyphens from the extracted output. This option defaults to 'off' for this reason. This feature primarily benefits applications when searching the text output without the use of intelligent hyphen monitoring. Default value is BFFALSE |
| SecureOptions_FilterOverprintedText |
Detect and remove duplicate, overprinted text from extracted output. This option enables the detection and removal of duplicate, overprinted text from the extracted output. It is not uncommon to see PDF documents with duplicate characters drawn very nearly on top of themselves for the purpose of supporting certain types of character attributes that may inlcude bolded, embossed, shadowed, or 3D text characteristics. Unfortunately, the overprinting may occur at character, intra-word, word, or line boundaries. This can have the unfortunate side effect of breaking valid words into a stream of unintelligable characters which in turn has adverse consequences on text searching. This feature addresses this problem by monitoring the position of every drawn piece of text within a line for overprinting situations. Most common use cases are covered though there are valid cases that are not detected when spaces are a part of one text operation but not another, causing the match algorihtm to fail. Additionally, this feature is disabled on any text that is drawn using a font that lacks valid character width metrics. Default value is BFFALSE |
| SecureOptions_BrokenPDFCorrection |
Enables correction of PDFs which has malformed internal structure. Major PDF reader like Adobe allows many deviations from standard PDF specifications. But Clean Content parser strictly follows the specification to read the pdf streams.Hence, though many readers can open broken pdf documents as they overlay the broken streams to correct the malformed internal structure. This option enables the correction of such broken Pdf documents if parsing fails for given input Pdf. Though Clean Content will try to recover as many PDFs it can , but there may be such broken streams which are too malformed to auto-correction. Therefore, there will be limitations to PDF corrections. Default value is BFFALSE |
| SecureOptions_GenerateSlideContentFingerprint |
Generate a fingerprint element based on the text and image content found for each slide. This option enables the generation of a fingerprint element with a type attribute of 'SlideContent'. This element is generated by Clean Content during analysis of a presentation. The value attribute provides the fingerprint as a 128 bit MD5 hash. The fingerprint for SlideContent is generated based on the text and images found on the slide. This allows the fingerprint to be consistent regardless of modifications due to positions, colors, shapes, masters, and other slide attributes. The SlideAppearance fingerprint is an extension of the SlideContent fingerprint that includes consideration for the applicable slide master, slide background, and the position and select formatting of slide content, including shapes. Numerous presentation features are excluded from the fingerprint calculation in order to improve the consistencty of the fingerprint across different versions of PowerPoint. This fingerprint can be leveraged to identify slides across a diverse document set that are substantially similar in content but may vary with respect to formatting. Default value is BFFALSE |
| SecureOptions_GenerateSlideAppearanceFingerprint |
Generate a fingerprint element for each slide based on the text, images, colors, shape positions, and applied master. This option enables the generation of a fingerprint element with a type attribute of 'SlideAppearance'. This element is generated by Clean Content during analysis of a presentation. The value attribute provides the fingerprint as a 128 bit MD5 hash. The SlideAppearance fingerprint is an extension of the SlideContent fingerprint and includes consideration for the slide background and the position and select formatting of slide content, including shapes. Numerous presentation features are excluded from the fingerprint calculation in order to improve the consistencty of the fingerprint across different versions of PowerPoint. This fingerprint can be leveraged to identify slides that are substantially similar in both content and appearance. Default value is BFFALSE |
| SecureOptions_GenerateGraphicDataFingerprint |
Generate a fingerprint element for each embedded graphic in the document. This option enables the generation of a fingerprint element with a type attribute of 'GraphicData'. This element is generated by Clean Content during analysis of embedded objects that are of type 'Graphic'. The value attribute provides the fingerprint as a 128 bit MD5 hash. This fingerprint can be leveraged to identify documents that a particular embedded image. Default value is BFFALSE |
| SecureOptions_ExcludeProcessingInfoElement |
Do not include the processinginfo element in XML output. For Testing Only! Do not include the processinginfo element in XML output. This option is for testing only! Removal of the processing info element allows QA processes that produce XML output at different times and with different source documents to easily compare resulting XML. Default value is BFFALSE |
| SecureOptions_IncludeLocators |
Include locator elements in output Include locator elements in output. Default value is BFFALSE |
| SecureOptions_ChangeStartingPageNumber |
Modify the page number a document starts at. When this option is true the StartingPageNumber option is used to modify the page number a document starts at. Applies to:
Default value is BFFALSE |
| SecureOptions_JustDisassemble |
Disassemble the source PowerPoint document into individual PowerPoint documents containing one slide each. When this option is true the input document will be disassembed into a set of new documents. At this time this only applies to disassembling a PowerPoint document into multiple PowerPoint documents, each containing one slide. The resulting files will be placed in the embedding export directory by default. Default value is BFFALSE |
| SecureOptions_JustAssemble |
Assemble the source PowerPoint file list into a single PowerPoint document, merging all slides. When this option is true the AssembleFileList option defines the list of PowerPoit documents to be assembled into a single PowerPoint document. The source document defined by the SourceFile option must contain a PowerPoint document that will be used as the source for document wide defaults. At this time this only applies to assembling a set of PowerPoint documents into a single PowerPoint document.. The resulting file will be placed in the embedding export directory by default. Default value is BFFALSE |
| SecureOptions_JustAnalyze |
Ignore all action settings and just analyze When this option is true all scrub targets with actions of SCRUB will act as if they are set to ANALYZE. This allows for an analysis with no copying of the source document and no chance anything will be scrubbed. Default value is BFFALSE |
| SecureOptions_OfficeXMLPartValidation |
Enable the process that validates all Office parts found in Office Open XML formats. The Office Open XML file formats, generated by Office 2007 and above, follow a specification that describes how a collection of related parts define an Office Document. Each part is stored as a unique file in the collection, and parts may reference other parts to define the structure of the document. Many of these parts are deeply inspected during the Clean Content analysis process, however this option activates additional analysis, extraction and scrubbing behavior that covers every part in the document in one way or another. When this option is set to True the following additional behaviors are active. The extracted output will contain a Collection element of type OfficeXMLPartDisclosureRisks that includes each questionable part using an OfficeXMLPartRisk element that provides further information about the part. There are 4 categories of parts that carry some level of disclosure risk: Rogue, Unexpected, Unanalyzed, and Alternate Content parts. Each of these is documented as a specific analysis target. Those analysis targets must be set to ANALYZE when this option is enabled in order to report that particular risk in the extracted output. Rogue parts will automatically be scrubbed whether this option is enabled or disabled because rogue parts serve no known valid purpose in the document. Unexpected parts will not be scrubbed since doing so might break the document structure. Unanalyzed parts will only be scrubbed if they are removable due to a specific scrub target (i.e. Printer Settings). The Choice portion of Alternate Content is always scrubbed whether this option is enabled or disabled. Alternate Content parts that are referenced within the Choice portion are removed unless they are required in another valid context whether this option is enabled or disabled. Default value is BFFALSE |
| SecureOptions_ValidateEmbeddedContent |
Enable the process that validates all embedded contents found in Office Open XML formats. This feature is an add on feature for OfficeXMLPartValidation. This feature enables scrubbing of the rogue content present inside the Office open documents. The Office Open XML file formats, generated by Office 2007 and above, follow a specification that describes how a collection of related parts define an Office Document. Each part is stored as a unique file in the collection, and parts may reference other parts to define the structure of the document. Many of these parts are deeply inspected during the Clean Content analysis process, however this option activates additional analysis, extraction and scrubbing behavior that covers every part in the document in one way or another. When this option is set to True the following additional behaviors are active. The extracted output will contain a Collection element of type OfficeXMLPartDisclosureRisks that includes each questionable part using an OfficeXMLPartRisk element that provides further information about the part. This falls under the category of Rogue part present in the document.Rogue parts will automatically be scrubbed because rogue parts serve no known valid purpose in the document. Default value is BFFALSE |
| SecureOptions_OfficeXMLCanonicalization |
Enable the process that canonicalizes Office XMLs.Note ScrubOption OfficeXMLFeatures must be set to canonicalize the file. Canonical XML is a normal form of XML, intended to allow relatively simple comparison of pairs of XML documents for equivalence; for this purpose, the Canonical XML transformation removes non-meaningful differences between the documents.Canonicalization involves UTF-8 encoding, attribute normalization , handle special characters , replace entity references and many more.Note ScrubOption OfficeXMLFeatures must be set to canonicalize the file. Default value is BFFALSE |
| SecureOptions_OfficeXMLFeatures |
Enable the features which does inspection and sanitatization of Office XMLs vulnerabilities. Once this option is enabled Clean content will start processing 2007 and above office file formats for XMLComments,XML External entity, XML CDATA and XML Unknown Namespaces. Once this option is set then only Clean Content will report existence of XML Comments,XMLCDATA, XML External entity or XML UnknownNamespace and scrub options for these features also work only when this flag is set. Default value is BFFALSE |
| SecureOptions_OfficeXMLRenameNamespacePrefix |
Rename namespace prefixes in all XML inside a MS office file.Note ScrubOption OfficeXMLFeatures must be set to rename namespace prefixes. Namespace prefix can contain sensitive information.It is therefore ,recommended to rename namespace prefixes to neutral prefixes.Note ScrubOption OfficeXMLFeatures must be set to rename namespace prefixes. Default value is BFFALSE |
| SecureOptions_UnhideHiddenCells |
Unhide hidden spreadsheet cells Unhide hidden sheets, rows, and columns found in spreadsheets. Default value is BFFALSE |
| SecureOptions_SimulatePowerPointAnimationsDuringAssembly |
Simulate PowerPoint Animations During Assembly. This option applies to the assembly of PowerPoint 2007 and above (PPTX). When set, this option will cause slides that originally contained animation to be expanded into a series of slides that simulate the animations by hiding and restoring slide elements to simulate the entrance and exit of animated elements. Applies to:
Default value is BFFALSE |
| enum IntegerOptions |
Options representing an integer value. Used with BFSetIntegerOption() and BFGetIntegerOption().
| enum FileFormatOptions |
Options representing a file format. Used with BFSetFileFormatOption(), BFGetFileFormatOption() and BFGetFileFormatResult().
Options representing a list of file formats. Used with BFSetFileFormatListOption() and BFGetFileFormatListOption().
| enum EnumOptions |
Options representing an enumeration of possible values. Used with BFSetEnumOption(), BFGetEnumOption().
Possible values for the enum option SecureOptions_ProcessingStatus
Possible values for the enum option SecureOptions_DecryptionStatus
Possible values for the enum option SecureOptions_OutputType
Possible values for the enum option SecureOptions_ColorObfuscatedTextRemediation
| enum EnumListOptions |
Options representing a list of enumerations of possible values. Used with BFSetEnumListOption().
Possible values for the enum list option SecureOptions_HeadersFootersBehavior
| enum HandlerOptions |
Options representing an element handler. Used with BFSetHandlerOption().
| enum FileOptions |
Options representing a stream of bytes. Used with BFSetFileOption() and BFGetFileOption().
| enum FileListOptions |
Options representing a list of files. Used with BFSetFileListOption() and BFGetFileListOption().
| enum DirectoryOptions |
Options representing a directory or folder in a file system. Used with BFSetDirectoryOption() and BFGetDirectoryOption().
| enum StringOptions |
Options representing a string. Used with BFSetStringOption() and BFGetStringOption().
| enum StringListOptions |
Options representing a list of strings. Used with BFSetStringListOption() and BFGetStringListOption().
| enum ScrubOptions |
Options representing targets that may be identified and removed. Used with BFSetScrubOption(), BFGetScrubOption() and BFGetScrubResult().
| enum AnalyzeOptions |
Options representing targets that may be identified. Used with BFSetAnalyzeOption(), BFGetAnalyzeOption() and BFGetAnalyzeResult().
| enum ObjectListOptions |
Options representing a list of structures Used with BFSetObjectListOption()
| enum ScrubOptionActions |
Values that represent the various actions that can be taken on a ScrubOption or AnalyzeOption.
| enum ScrubOptionReactions |
Values that represent the various reactions to an action taken on a ScrubOption or AnalyzeOption.
| BFEXPORT_FUNCDEC int BFSetScrubOption | ( | const BFHANDLE | request, | |
| const enum ScrubOptions | option, | |||
| const enum ScrubOptionActions | action, | |||
| BFHANDLE * | errorinfo | |||
| ) |
Sets a scrub option.
| request | BFHANDLE that represents the request | |
| option | One of the values in ScrubOptions | |
| action | One of the actions in Actions | |
| 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. |
| BFEXPORT_FUNCDEC int BFSetAnalyzeOption | ( | const BFHANDLE | request, | |
| const enum AnalyzeOptions | option, | |||
| const enum ScrubOptionActions | action, | |||
| BFHANDLE * | errorinfo | |||
| ) |
Sets an analyze option.
| request | BFHANDLE that represents the request | |
| option | One of the values in AnalyzeOptions | |
| action | One of the actions in the Actions enum | |
| 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. |
| BFEXPORT_FUNCDEC int BFSetBooleanOption | ( | const BFHANDLE | request, | |
| const enum BooleanOptions | option, | |||
| const int | value, | |||
| BFHANDLE * | errorinfo | |||
| ) |
Sets a boolean option.
| request | BFHANDLE that represents the request | |
| option | One of the values in BooleanOptions | |
| value | BFTRUE or BFFALSE | |
| 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. |
| BFEXPORT_FUNCDEC int BFSetIntegerOption | ( | const BFHANDLE | request, | |
| const enum IntegerOptions | option, | |||
| const BFINT64 | value, | |||
| BFHANDLE * | errorinfo | |||
| ) |
Sets an integer option.
| request | BFHANDLE that represents the request | |
| option | One of the values in IntegerOptions | |
| value | the option should take | |
| 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. |
| BFEXPORT_FUNCDEC int BFSetEnumOption | ( | const BFHANDLE | request, | |
| const enum EnumOptions | option, | |||
| const int | value, | |||
| BFHANDLE * | errorinfo | |||
| ) |
Sets an enum option.
| request | BFHANDLE that represents the request | |
| option | One of the values in EnumOptions | |
| value | the option should take | |
| 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. |
| BFEXPORT_FUNCDEC int BFSetEnumListOption | ( | const BFHANDLE | request, | |
| const enum EnumListOptions | option, | |||
| const int | values[], | |||
| int | count, | |||
| BFHANDLE * | errorinfo | |||
| ) |
Sets an enum list option.
| request | BFHANDLE that represents the request | |
| option | One of the values in EnumListOptions | |
| values | An array integers | |
| count | Number of integers in the array | |
| 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. |
| BFEXPORT_FUNCDEC int BFSetStringOption | ( | const BFHANDLE | request, | |
| const enum StringOptions | option, | |||
| const wchar_t * | string, | |||
| BFHANDLE * | errorinfo | |||
| ) |
Sets a string option.
| request | BFHANDLE that represents the request | |
| option | One of the values in StringOptions | |
| string | pointer to a NULL terminated UNICODE string | |
| 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. |
| BFEXPORT_FUNCDEC int BFSetStringListOption | ( | const BFHANDLE | request, | |
| const enum StringListOptions | option, | |||
| const wchar_t * | strings[], | |||
| int | count, | |||
| BFHANDLE * | errorinfo | |||
| ) |
Sets a string list option.
| request | BFHANDLE that represents the request | |
| option | One of the values in StringListOptions | |
| strings | An array of pointers to a NULL terminated UNICODE strings | |
| count | Number of strings in the array | |
| 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. |
| BFEXPORT_FUNCDEC int BFSetFileOption | ( | const BFHANDLE | request, | |
| const enum FileOptions | option, | |||
| const wchar_t * | path, | |||
| BFHANDLE * | errorinfo | |||
| ) |
Sets a file option using a path to the file.
| request | BFHANDLE that represents the request | |
| option | One of the values in FileOptions | |
| path | Pointer to a NULL terminated UNICODE string containing a fully qualified path to the file | |
| 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. |
| BFEXPORT_FUNCDEC int BFSetDateOption | ( | const BFHANDLE | request, | |
| const enum DateOptions | option, | |||
| int | year, | |||
| int | month, | |||
| int | day, | |||
| int | hour, | |||
| int | minute, | |||
| int | second, | |||
| BFHANDLE * | errorinfo | |||
| ) |
Sets a date option. The date information provided is without locale or time zone information.
| request | BFHANDLE that represents the request | |
| option | One of the values in DateOptions | |
| year | The year, value is AD | |
| month | The month, value is 0-based where 0 is January | |
| day | Day of the month | |
| hour | Hour | |
| minute | Minute | |
| second | Second | |
| 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. |
| BFEXPORT_FUNCDEC int BFSetDurationOption | ( | const BFHANDLE | request, | |
| const enum DurationOptions | option, | |||
| int | duration, | |||
| BFHANDLE * | errorinfo | |||
| ) |
Sets a duration option.
| request | BFHANDLE that represents the request | |
| option | One of the values in DurationOptions | |
| duration | Duration in milliseconds | |
| 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. |
| BFEXPORT_FUNCDEC int BFSetDirectoryOption | ( | const BFHANDLE | request, | |
| const enum DirectoryOptions | option, | |||
| const wchar_t * | path, | |||
| BFHANDLE * | errorinfo | |||
| ) |
Sets a directory option using a path to the directory.
| request | BFHANDLE that represents the request | |
| option | One of the values in DirectoryOptions | |
| path | Pointer to a NULL terminated UNICODE string containing a fully qualified path to the directory | |
| 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. |
| BFEXPORT_FUNCDEC int BFSetFileOptionUsingMemory | ( | const BFHANDLE | request, | |
| const enum FileOptions | option, | |||
| const void * | memory, | |||
| const long | length, | |||
| BFHANDLE * | errorinfo | |||
| ) |
Sets a file option using a block of memory.
| request | BFHANDLE that represents the request | |
| option | One of the values in FileOptions | |
| memory | A pointer to a block of memory containing the entire file | |
| length | The size of the file in memory | |
| 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. |
| BFEXPORT_FUNCDEC int BFSetFileOptionUsingChannel | ( | const BFHANDLE | request, | |
| const enum FileOptions | option, | |||
| BFCHANNEL * | channel, | |||
| BFHANDLE * | errorinfo | |||
| ) |
Sets a file option using a set of callbacks routines.
| request | BFHANDLE that represents the request | |
| option | One of the values in FileOptions | |
| channel | Pointer to a BFCHANNEL structure contained read, write and other IO routines supplied your code | |
| 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. |
| BFEXPORT_FUNCDEC int BFSetFileOptionUsingChannelCopy | ( | const BFHANDLE | request, | |
| const enum FileOptions | option, | |||
| BFCHANNEL * | channel, | |||
| BFCHANNEL ** | copy, | |||
| BFHANDLE * | errorinfo | |||
| ) |
FOR INTERNAL USE ONLY Sets a file option using a set of callbacks routines, making a copy of those routines.
| request | BFHANDLE that represents the request | |
| option | One of the values in FileOptions | |
| channel | Pointer to a BFCHANNEL structure contained read, write and other IO routines supplied your code. | |
| copy | Pointer that recieves a pointer to the copied BFCHANNEL. | |
| 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. |
| BFEXPORT_FUNCDEC void BFFreeChannelCopy | ( | BFCHANNEL * | channel | ) |
FOR INTERNAL USE ONLY Frees a channel.
| channel | Pointer to a BFCHANNEL structure to be freed. This pointer must have been the result of a BFSetFileOptionUsingChannelCopy() call |
| BFEXPORT_FUNCDEC int BFSetFileFormatOption | ( | const BFHANDLE | request, | |
| const enum FileFormatOptions | option, | |||
| const enum FileFormats | format, | |||
| BFHANDLE * | errorinfo | |||
| ) |
Sets a file format option.
| request | BFHANDLE that represents the request | |
| option | One of the values in FileFormatOptions | |
| format | One of the values in FileFormats | |
| 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. |
| BFEXPORT_FUNCDEC int BFSetFileFormatListOption | ( | const BFHANDLE | request, | |
| const enum FileFormatListOptions | option, | |||
| const enum FileFormats | formats[], | |||
| const int | count, | |||
| BFHANDLE * | errorinfo | |||
| ) |
Sets a file format list option.
| request | BFHANDLE that represents the request | |
| option | One of the values in FileFormatListOptions | |
| formats | Any array containing zero or more FileFormats | |
| count | Number of FileFormats in the formats array | |
| 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. |
| BFEXPORT_FUNCDEC int BFSetHandlerOption | ( | const BFHANDLE | request, | |
| const enum HandlerOptions | option, | |||
| const BFELEMENTHANDLER * | handler, | |||
| BFHANDLE * | errorinfo | |||
| ) |
Sets an element handler option.
| request | BFHANDLE that represents the request | |
| option | Current only the value ExtractElementHandler is allowed | |
| handler | A BFELEMENTHANDLER structure with all function pointers initialized to NULL or valid functions | |
| 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. |
| BFEXPORT_FUNCDEC int BFSetHandlerOptionCopy | ( | const BFHANDLE | request, | |
| const enum HandlerOptions | option, | |||
| const BFELEMENTHANDLER * | handler, | |||
| BFHANDLE * | errorinfo | |||
| ) |
| BFEXPORT_FUNCDEC int BFGetScrubOption | ( | const BFHANDLE | request, | |
| const enum ScrubOptions | option, | |||
| enum ScrubOptionActions * | action, | |||
| BFHANDLE * | errorinfo | |||
| ) |
Gets a scrub option.
| request | BFHANDLE that represents the request | |
| option | One of the values in ScrubOptions | |
| action | Pointer to an Actions that will receive the value | |
| 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. |
| BFEXPORT_FUNCDEC int BFGetAnalyzeOption | ( | const BFHANDLE | request, | |
| const enum AnalyzeOptions | option, | |||
| enum ScrubOptionActions * | action, | |||
| BFHANDLE * | errorinfo | |||
| ) |
Gets an analyze option.
| request | BFHANDLE that represents the request | |
| option | One of the values in AnalyzeOptions | |
| action | Pointer to an Actions that will receive the value | |
| 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. |
| BFEXPORT_FUNCDEC int BFGetBooleanOption | ( | const BFHANDLE | request, | |
| const enum BooleanOptions | option, | |||
| int * | value, | |||
| BFHANDLE * | errorinfo | |||
| ) |
Gets a boolean option.
| request | BFHANDLE that represents the request | |
| option | One of the values in BooleanOptions | |
| value | Pointer to an int that will receive either BFTRUE or BFFALSE | |
| 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. |
| BFEXPORT_FUNCDEC int BFGetIntegerOption | ( | const BFHANDLE | request, | |
| const enum IntegerOptions | option, | |||
| BFINT64 * | value, | |||
| BFHANDLE * | errorinfo | |||
| ) |
Gets an integer option.
| request | BFHANDLE that represents the request | |
| option | One of the values in IntegerOptions | |
| value | Pointer to an int that will receive the value | |
| 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. |
| BFEXPORT_FUNCDEC int BFGetStringOption | ( | const BFHANDLE | request, | |
| const enum StringOptions | option, | |||
| wchar_t * | string, | |||
| int | length, | |||
| BFHANDLE * | errorinfo | |||
| ) |
Gets a string option.
| request | BFHANDLE that represents the request | |
| option | One of the values in StringOptions | |
| string | Pointer to a buffer of wide charcters that will receive the zero-terminated UNICODE string | |
| length | Length of the buffer in characters. Returned string will be truncated if it will not fit in the buffer. | |
| 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. |
| BFEXPORT_FUNCDEC int BFGetEnumOption | ( | const BFHANDLE | request, | |
| const enum EnumOptions | option, | |||
| int * | value, | |||
| BFHANDLE * | errorinfo | |||
| ) |
Gets a enum option.
| request | BFHANDLE that represents the request | |
| option | One of the values in EnumOptions | |
| value | Pointer to an int that will receive the value | |
| 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. |
| BFEXPORT_FUNCDEC int BFGetStringListOption | ( | const BFHANDLE | request, | |
| const enum StringListOptions | option, | |||
| wchar_t * | strings[], | |||
| int * | count, | |||
| int | length, | |||
| BFHANDLE * | errorinfo | |||
| ) |
Gets a string list option.
| request | BFHANDLE that represents the request | |
| option | One of the values in StringListOptions | |
| strings | Array of pointers to Unicode string buffers that will receive the values. If this parameter is NULL then count will be set to the size of the array required to hold all the strings. | |
| count | Pointer to an integer that specifies how large the passed strings array is and will receive the actual number of strings. | |
| length | Length of the string buffers in characters. Each returned string will be truncated if it does not fit in the buffer. | |
| 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. |
| BFEXPORT_FUNCDEC int BFGetTargetOptionFormatInformation | ( | const int | option, | |
| enum FileFormats * | formats, | |||
| wchar_t * | descriptions[], | |||
| int * | count, | |||
| const int | length, | |||
| BFHANDLE * | errorinfo | |||
| ) |
Gets a list of file formats and associated descriptions that apply to a given target option (an analyze option or scrub option).
| option | One of the values in AnalyzeOptions or ScrubOptions | |
| formats | Array of FileFormats that will recieve the formats that apply to the target option. If this parameter or the descriptions parameter is NULL then count will be set to the size of the array required to hold all the descriptions. | |
| descriptions | Array of pointers to Unicode string buffers that will receive the descirptions of how each formats applies to the target option. If this parameter or the formats parameter is NULL then count will be set to the size of the array required to hold all the descriptions. | |
| count | Pointer to an integer that specifies how large the passed arrays (they must be the same) are and will receive the actual number of items. | |
| length | Length of the string buffers in characters. Each returned string will be truncated if it does not fit in the buffer. | |
| 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. |
| BFEXPORT_FUNCDEC int BFGetFileOption | ( | const BFHANDLE | request, | |
| const enum FileOptions | option, | |||
| wchar_t * | path, | |||
| int | length, | |||
| BFHANDLE * | errorinfo | |||
| ) |
Gets a file option.
| request | BFHANDLE that represents the request | |
| option | One of the values in FileOptions | |
| path | Pointer to a buffer of wide charcters that will receive the zero-terminated UNICODE string contained the full path to the file | |
| length | Length of the buffer. Returned path will be truncated if it will not fit in the buffer. | |
| 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. |
| BFEXPORT_FUNCDEC int BFGetDirectoryOption | ( | const BFHANDLE | request, | |
| const enum DirectoryOptions | option, | |||
| wchar_t * | path, | |||
| int | length, | |||
| BFHANDLE * | errorinfo | |||
| ) |
Gets a directory option.
| request | BFHANDLE that represents the request | |
| option | One of the values in FileOptions | |
| path | Pointer to a buffer of wide charcters that will receive the zero-terminated UNICODE string contained the full path to the directory | |
| length | Length of the buffer. Returned path will be truncated if it will not fit in the buffer. | |
| 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. |
| BFEXPORT_FUNCDEC int BFGetFileFormatOption | ( | const BFHANDLE | request, | |
| const enum FileFormatOptions | option, | |||
| enum FileFormats * | format, | |||
| BFHANDLE * | errorinfo | |||
| ) |
Gets a file format option.
| request | BFHANDLE that represents the request | |
| option | One of the values in FileFormatOptions | |
| format | Pointer to a FileFormats that will receive the value | |
| 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. |
| BFEXPORT_FUNCDEC int BFGetFileFormatListOption | ( | const BFHANDLE | request, | |
| const enum FileFormatListOptions | option, | |||
| enum FileFormats * | formats, | |||
| int * | count, | |||
| BFHANDLE * | errorinfo | |||
| ) |
Gets a file format list option.
| request | BFHANDLE that represents the request | |
| option | One of the values in FileFormatListOptions | |
| formats | Pointer to an array of FileFormats that will receive the values. If this parameter is NULL then count will be set to the size of the array required to hold all the FileFormat values. | |
| count | Pointer to an integer that specifies how large the passed formats array is and will receive the actual number of FileFormats values. | |
| 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. |
| BFEXPORT_FUNCDEC int BFReadOptionsFromXML | ( | const BFHANDLE | request, | |
| const wchar_t * | path, | |||
| BFHANDLE * | errorinfo | |||
| ) |
Read options from an XML file.
| request | BFHANDLE that represents the request | |
| path | Full path to the XML file to read | |
| 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. |
| BFEXPORT_FUNCDEC int BFWriteOptionsToXML | ( | const BFHANDLE | request, | |
| const wchar_t * | path, | |||
| BFHANDLE * | errorinfo | |||
| ) |
Write options from an XML file.
| request | BFHANDLE that represents the request | |
| path | Full path to the XML file to write | |
| 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. |
| BFEXPORT_FUNCDEC enum BooleanOptions* BFGetAllBooleanOptions | ( | int * | count | ) |
Gets a list of all boolean options.
| count | Pointer to an int that receives the count of boolean options. |
| BFEXPORT_FUNCDEC enum IntegerOptions* BFGetAllIntegerOptions | ( | int * | count | ) |
Gets a list of all integer options.
| count | Pointer to an int that receives the count of integer options. |
| BFEXPORT_FUNCDEC enum FileFormatOptions* BFGetAllFileFormatOptions | ( | int * | count | ) |
Gets a list of all file format options.
| count | Pointer to an int that receives the count of file format options. |
| BFEXPORT_FUNCDEC enum FileFormatListOptions* BFGetAllFileFormatListOptions | ( | int * | count | ) |
Gets a list of all file format list options.
| count | Pointer to an int that receives the count of file format list options. |
| BFEXPORT_FUNCDEC enum EnumOptions* BFGetAllEnumOptions | ( | int * | count | ) |
Gets a list of all enumeration options.
| count | Pointer to an int that receives the count of enumeration options. |
| BFEXPORT_FUNCDEC enum EnumListOptions* BFGetAllEnumListOptions | ( | int * | count | ) |
Gets a list of all enumeration list options.
| count | Pointer to an int that receives the count of enumeration list options. |
| BFEXPORT_FUNCDEC enum HandlerOptions* BFGetAllHandlerOptions | ( | int * | count | ) |
Gets a list of all element handler options.
| count | Pointer to an int that receives the count of element handler options. |
| BFEXPORT_FUNCDEC enum FileOptions* BFGetAllFileOptions | ( | int * | count | ) |
Gets a list of all file options.
| count | Pointer to an int that receives the count of file options. |
| BFEXPORT_FUNCDEC enum FileListOptions* BFGetAllFileListOptions | ( | int * | count | ) |
Gets a list of all file list options.
| count | Pointer to an int that receives the count of file list options. |
| BFEXPORT_FUNCDEC enum DirectoryOptions* BFGetAllDirectoryOptions | ( | int * | count | ) |
Gets a list of all directory options.
| count | Pointer to an int that receives the count of directory options. |
| BFEXPORT_FUNCDEC enum StringOptions* BFGetAllStringOptions | ( | int * | count | ) |
Gets a list of all string options.
| count | Pointer to an int that receives the count of string options. |
| BFEXPORT_FUNCDEC enum StringListOptions* BFGetAllStringListOptions | ( | int * | count | ) |
Gets a list of all string list options.
| count | Pointer to an int that receives the count of string list options. |
| BFEXPORT_FUNCDEC enum ScrubOptions* BFGetAllScrubOptions | ( | int * | count | ) |
Gets a list of all scrub target options.
| count | Pointer to an int that receives the count of scrub target options. |
| BFEXPORT_FUNCDEC enum AnalyzeOptions* BFGetAllAnalyzeOptions | ( | int * | count | ) |
Gets a list of all analyze target options.
| count | Pointer to an int that receives the count of analyze target options. |
| BFEXPORT_FUNCDEC enum ObjectListOptions* BFGetAllObjectListOptions | ( | int * | count | ) |
Gets a list of all object list options.
| count | Pointer to an int that receives the count of object list options. |
