Fields and Properties

---

Description

Functions and structures that that support modification of Fields and Properties

Classes
struct	SECUREOPTIONS_ACTIONONLYFIELD
struct	SECUREOPTIONS_STRINGFIELD
struct	SECUREOPTIONS_ACTIONONLYPROPERTY
struct	SECUREOPTIONS_STRINGPROPERTY
struct	SECUREOPTIONS_DURATIONPROPERTY
struct	SECUREOPTIONS_DATEPROPERTY
struct	SECUREOPTIONS_INTEGERPROPERTY
struct	SECUREOPTIONS_BOOLEANPROPERTY
struct	SECUREOPTIONS_FLOATPROPERTY
Enumerations
enum	SecureOptions_Fields_Actions {   SecureOptions_Fields_Action_None = 1,   SecureOptions_Fields_Action_Scrub = 2,   SecureOptions_Fields_Action_Replace = 3,   SecureOptions_Fields_Action_ScrubAndReplace = 4 }
enum	SecureOptions_Properties_Actions {   SecureOptions_Properties_Action_None = 1,   SecureOptions_Properties_Action_Scrub = 2,   SecureOptions_Properties_Action_Replace = 3,   SecureOptions_Properties_Action_AddOrReplace = 4,   SecureOptions_Properties_Action_Inherit = 5 }
Functions
BFEXPORT_FUNCDEC int	BFNewStringProperty (const wchar_t *name, const wchar_t *description, SECUREOPTIONS_STRINGPROPERTY *newProperty, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFNewDurationProperty (const wchar_t *name, const wchar_t *description, SECUREOPTIONS_DURATIONPROPERTY *newProperty, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFNewDateProperty (const wchar_t *name, const wchar_t *description, SECUREOPTIONS_DATEPROPERTY *newProperty, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFNewIntegerProperty (const wchar_t *name, const wchar_t *description, SECUREOPTIONS_INTEGERPROPERTY *newProperty, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFNewBooleanProperty (const wchar_t *name, const wchar_t *description, SECUREOPTIONS_BOOLEANPROPERTY *newProperty, BFHANDLE *errorinfo)
BFEXPORT_FUNCDEC int	BFNewFloatProperty (const wchar_t *name, const wchar_t *description, SECUREOPTIONS_FLOATPROPERTY *newProperty, BFHANDLE *errorinfo)

---

Enumeration Type Documentation

enum SecureOptions_Fields_Actions

Values that represent the various actions that can be taken on a Field.

Enumerator:

SecureOptions_Fields_Action_None	Take no action on this field
SecureOptions_Fields_Action_Scrub	Scrub the field definition leaving the field result text alone
SecureOptions_Fields_Action_Replace	Replace the field result text with the string provided
SecureOptions_Fields_Action_ScrubAndReplace	Scrub the field definition and replace the field result text with the string provided

enum SecureOptions_Properties_Actions

Values that represent the various actions that can be taken on a Property.

Enumerator:

SecureOptions_Properties_Action_None	Take no action on this property
SecureOptions_Properties_Action_Scrub	Remove the property from the document
SecureOptions_Properties_Action_Replace	Replace the property with the value provided but only if the property already exists in the document
SecureOptions_Properties_Action_AddOrReplace	Add or replace the property with the value provided
SecureOptions_Properties_Action_Inherit	Take the action defined by the more general property scrub tagrets like SummaryProperties, etc.

---

Function Documentation

BFEXPORT_FUNCDEC int BFNewStringProperty	(	const wchar_t *	name,
		const wchar_t *	description,
		SECUREOPTIONS_STRINGPROPERTY *	newProperty,
		BFHANDLE *	errorinfo
	)

Creates a custom property with a type of String. This method is not thread safe. Custom properties should be created once in a single thread but may be reused across threads.

Parameters:

	name	Name of the property. Reuse of a previously added custom property name or the name of one of the standard properties will return that property not a new one.
	description	A text description of the property
	newProperty	A pointer to the SecureOptions_StringProperty structure that will recieve the action and newValue options for this property
	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 BFNewDurationProperty	(	const wchar_t *	name,
		const wchar_t *	description,
		SECUREOPTIONS_DURATIONPROPERTY *	newProperty,
		BFHANDLE *	errorinfo
	)

Creates a custom property with a type of Duration. This method is not thread safe. Custom properties should be created once in a single thread but may be reused across threads.

Parameters:

	name	Name of the property. Reuse of a previously added custom property name or the name of one of the standard properties will return that property not a new one.
	description	A text description of the property
	newProperty	A pointer to the SecureOptions_DurationProperty structure that will recieve the action and newValue options for this property
	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 BFNewDateProperty	(	const wchar_t *	name,
		const wchar_t *	description,
		SECUREOPTIONS_DATEPROPERTY *	newProperty,
		BFHANDLE *	errorinfo
	)

Creates a custom property with a type of Date. This method is not thread safe. Custom properties should be created once in a single thread but may be reused across threads.

Parameters:

	name	Name of the property. Reuse of a previously added custom property name or the name of one of the standard properties will return that property not a new one.
	description	A text description of the property
	newProperty	A pointer to the SecureOptions_DateProperty structure that will recieve the action and newValue options for this property
	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 BFNewIntegerProperty	(	const wchar_t *	name,
		const wchar_t *	description,
		SECUREOPTIONS_INTEGERPROPERTY *	newProperty,
		BFHANDLE *	errorinfo
	)

Creates a custom property with a type of Integer. This method is not thread safe. Custom properties should be created once in a single thread but may be reused across threads.

Parameters:

	name	Name of the property. Reuse of a previously added custom property name or the name of one of the standard properties will return that property not a new one.
	description	A text description of the property
	newProperty	A pointer to the SecureOptions_IntegerProperty structure that will recieve the action and newValue options for this property
	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 BFNewBooleanProperty	(	const wchar_t *	name,
		const wchar_t *	description,
		SECUREOPTIONS_BOOLEANPROPERTY *	newProperty,
		BFHANDLE *	errorinfo
	)

Creates a custom property with a type of Boolean. This method is not thread safe. Custom properties should be created once in a single thread but may be reused across threads.

Parameters:

	name	Name of the property. Reuse of a previously added custom property name or the name of one of the standard properties will return that property not a new one.
	description	A text description of the property
	newProperty	A pointer to the SecureOptions_BooleanProperty structure that will recieve the action and newValue options for this property
	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 BFNewFloatProperty	(	const wchar_t *	name,
		const wchar_t *	description,
		SECUREOPTIONS_FLOATPROPERTY *	newProperty,
		BFHANDLE *	errorinfo
	)

Creates a custom property with a type of Float. This method is not thread safe. Custom properties should be created once in a single thread but may be reused across threads.

Parameters:

	name	Name of the property. Reuse of a previously added custom property name or the name of one of the standard properties will return that property not a new one.
	description	A text description of the property
	newProperty	A pointer to the SecureOptions_FloatProperty structure that will recieve the action and newValue options for this property
	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