Option information

Description

Functions that provide information about a particular option

Functions
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 BFGetOptionId	(	int	option,
		wchar_t *	name,
		int	length,
		BFHANDLE *	errorinfo
	)

Gets the identifier for an option. The id will be less than 80 characters long.

Parameters:

	option	One of the values in ScrubOptions, AnalyzeOptions, BooleanOptions, FileFormatOptions or FileOptions
	name	Pointer to a buffer of wide charcters that will receive the zero-terminated UNICODE id
	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 BFGetOptionName	(	int	option,
		wchar_t *	name,
		int	length,
		BFHANDLE *	errorinfo
	)

Gets the short name for an option. The name will be less than 80 characters long.

Parameters:

	option	One of the values in ScrubOptions, AnalyzeOptions, BooleanOptions, FileFormatOptions or FileOptions
	name	Pointer to a buffer of wide charcters that will receive the zero-terminated UNICODE short name
	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 BFGetOptionShortDescription	(	int	option,
		wchar_t *	description,
		int	length,
		BFHANDLE *	errorinfo
	)

Gets the short description for an option. The description will be less than 1024 characters long.

Parameters:

	option	One of the values in ScrubOptions, AnalyzeOptions, BooleanOptions, FileFormatOptions or FileOptions
	description	Pointer to a buffer of wide charcters that will receive the zero-terminated UNICODE short description
	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 BFGetOptionLongDescription	(	int	option,
		wchar_t *	description,
		int	length,
		BFHANDLE *	errorinfo
	)

Gets the long description for an option. The description will be less than 10240 characters long.

Parameters:

	option	One of the values in ScrubOptions, AnalyzeOptions, BooleanOptions, FileFormatOptions or FileOptions
	description	Pointer to a buffer of wide charcters that will receive the zero-terminated UNICODE long description
	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.