secureapi.h File Reference

#include "commondefs.h"
#include <stdlib.h>
#include <wchar.h>
#include <string.h>
#include <exception>
#include <stdexcept>
#include <string>
#include <stdio.h>

Go to the source code of this file.

Classes
struct	BFCHANNEL
class	BFTransformException
class	BFChannel
struct	BFCPPCHANNEL
class	BFSecureResponse
class	BFOptionSet
class	BFSecureRequest
Defines
#define	BFSTARTUPFEATURE_DEBUG   0x00000001
#define	BFSTARTUPFEATURE_LOGINFO   0x00000002
#define	BFCHANNELCANREAD   0x0001
#define	BFCHANNELCANWRITE   0x0002
Typedefs
typedef long(*	BFChannelRead )(void *channel, void *buffer, BFINT32 count, BFINT64 position)
typedef void(*	BFChannelWrite )(void *channel, void *buffer, BFINT32 count, BFINT64 position)
typedef BFINT64(*	BFChannelSize )(void *channel)
typedef long(*	BFChannelSupports )(void *channel)
typedef void(*	BFChannelClose )(void *channel)
typedef void(*	BFChannelTruncate )(void *channel, BFINT64 size)
Functions
BFEXPORT_FUNCDEC int	BFStartup (int features)
BFEXPORT_FUNCDEC int	BFStartupEx (int features, char *jarPath, char *jrePath, char *jreOptions[], int jreOptionsLen, int jreOptionsIgnoreUnknown)
BFEXPORT_FUNCDEC void	BFShutdown ()
BFEXPORT_FUNCDEC void	BFAttachThread (void)
BFEXPORT_FUNCDEC void	BFDetachThread (void)
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)
BFEXPORT_FUNCDEC int	BFSetScrubOption (const BFHANDLE request, const enum ScrubOptions option, const enum ScrubOptionActions action, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFSetAnalyzeOption (const BFHANDLE request, const enum AnalyzeOptions option, const enum ScrubOptionActions action, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFSetBooleanOption (const BFHANDLE request, const enum BooleanOptions option, const int value, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFSetIntegerOption (const BFHANDLE request, const enum IntegerOptions option, const BFINT64 value, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFSetEnumOption (const BFHANDLE request, const enum EnumOptions option, const int value, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFSetEnumListOption (const BFHANDLE request, const enum EnumListOptions option, const int values[], int count, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFSetStringOption (const BFHANDLE request, const enum StringOptions option, const wchar_t *string, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFSetStringListOption (const BFHANDLE request, const enum StringListOptions option, const wchar_t *strings[], int count, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFSetFileOption (const BFHANDLE request, const enum FileOptions option, const wchar_t *path, BFHANDLE *errorinfo)
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)
BFEXPORT_FUNCDEC int	BFSetDurationOption (const BFHANDLE request, const enum DurationOptions option, int duration, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFSetDirectoryOption (const BFHANDLE request, const enum DirectoryOptions option, const wchar_t *path, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFSetFileOptionUsingMemory (const BFHANDLE request, const enum FileOptions option, const void *memory, const long length, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFSetFileOptionUsingChannel (const BFHANDLE request, const enum FileOptions option, BFCHANNEL *channel, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFSetFileOptionUsingChannelCopy (const BFHANDLE request, const enum FileOptions option, BFCHANNEL *channel, BFCHANNEL **copy, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC void	BFFreeChannelCopy (BFCHANNEL *channel)
BFEXPORT_FUNCDEC int	BFSetFileFormatOption (const BFHANDLE request, const enum FileFormatOptions option, const enum FileFormats format, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFSetFileFormatListOption (const BFHANDLE request, const enum FileFormatListOptions option, const enum FileFormats formats[], const int count, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFSetHandlerOption (const BFHANDLE request, const enum HandlerOptions option, const BFELEMENTHANDLER *handler, BFHANDLE *errorinfo)
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)
BFEXPORT_FUNCDEC int	BFGetAnalyzeOption (const BFHANDLE request, const enum AnalyzeOptions option, enum ScrubOptionActions *action, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFGetBooleanOption (const BFHANDLE request, const enum BooleanOptions option, int *value, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFGetIntegerOption (const BFHANDLE request, const enum IntegerOptions option, BFINT64 *value, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFGetStringOption (const BFHANDLE request, const enum StringOptions option, wchar_t *string, int length, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFGetEnumOption (const BFHANDLE request, const enum EnumOptions option, int *value, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFGetStringListOption (const BFHANDLE request, const enum StringListOptions option, wchar_t *strings[], int *count, int length, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFGetTargetOptionFormatInformation (const int option, enum FileFormats *formats, wchar_t *descriptions[], int *count, const int length, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFGetFileOption (const BFHANDLE request, const enum FileOptions option, wchar_t *path, int length, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFGetDirectoryOption (const BFHANDLE request, const enum DirectoryOptions option, wchar_t *path, int length, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFGetFileFormatOption (const BFHANDLE request, const enum FileFormatOptions option, enum FileFormats *format, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFGetFileFormatListOption (const BFHANDLE request, const enum FileFormatListOptions option, enum FileFormats *formats, int *count, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFReadOptionsFromXML (const BFHANDLE request, const wchar_t *path, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFWriteOptionsToXML (const BFHANDLE request, const wchar_t *path, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFCloseSecureResponse (const BFHANDLE response, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFGetScrubResult (const BFHANDLE response, const enum ScrubOptions option, enum ScrubOptionReactions *result, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFGetAnalyzeResult (const BFHANDLE response, const enum AnalyzeOptions option, enum ScrubOptionReactions *reaction, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFGetBooleanResult (const BFHANDLE response, const enum BooleanOptions option, int *result, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFGetEnumResult (const BFHANDLE response, const enum EnumOptions option, int *result, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFGetFileFormatResult (const BFHANDLE response, const enum FileFormatOptions option, enum FileFormats *format, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFCompareResponse (const BFHANDLE response1, const BFHANDLE response2, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFGetOptionId (int option, wchar_t *name, int length, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFGetOptionName (int option, wchar_t *name, int length, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFGetOptionShortDescription (int option, wchar_t *description, int length, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFGetOptionLongDescription (int option, wchar_t *description, int length, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFGetFileFormatName (const enum FileFormats format, wchar_t *name, int length, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFGetFileFormatId (const enum FileFormats format, wchar_t *id, int length, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFGetFileFormatDescription (const enum FileFormats format, wchar_t *description, int length, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFGetFileFormatExtension (const enum FileFormats format, wchar_t *extension, int length, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC wchar_t const *	BFGetErrorMessage (const BFHANDLE errorinfo)
BFEXPORT_FUNCDEC wchar_t const *	BFGetExtendedErrorMessage (const BFHANDLE errorinfo)
BFEXPORT_FUNCDEC BFHANDLE	BFGetErrorCause (const BFHANDLE errorinfo)
BFEXPORT_FUNCDEC void	BFCloseErrorInfo (const BFHANDLE errorinfo)
BFEXPORT_FUNCDEC int	BFHelperGetDateString (BFINT64 ms, wchar_t *string, int length, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC void	BFHelperGetDurationString (BFINT64 ms, wchar_t *string, int length)
BFEXPORT_FUNCDEC void	BFHelperGetDoubleString (double d, wchar_t *string, int length)
void	BFCppChannelClose (void *channel)
BFINT64	BFCppChannelSize (void *channel)
long	BFCppChannelSupports (void *channel)
void	BFCppChannelWrite (void *channel, void *buf, BFINT32 len, BFINT64 pos)
long	BFCppChannelRead (void *channel, void *buf, BFINT32 len, BFINT64 pos)
void	BFCppChannelTruncate (void *channel, BFINT64 size)
void	InitChannelForCpp (BFCHANNEL *channel)

---

Function Documentation

void BFCppChannelClose

(

void *

channel

)

[inline]

BFINT64 BFCppChannelSize

(

void *

channel

)

[inline]

long BFCppChannelSupports

(

void *

channel

)

[inline]

void BFCppChannelWrite	(	void *	channel,
		void *	buf,
		BFINT32	len,
		BFINT64	pos
	)			[inline]

long BFCppChannelRead	(	void *	channel,
		void *	buf,
		BFINT32	len,
		BFINT64	pos
	)			[inline]

void BFCppChannelTruncate	(	void *	channel,
		BFINT64	size
	)			[inline]

void InitChannelForCpp

(

BFCHANNEL *

channel

)

[inline]