FunctionSettings Struct Reference

#include <database.h>

Detailed Description

A FunctionSettings object defines the IDs and behaviour of the stored function.

Public Member Functions
	FunctionSettings ()
MAXON_IMPLICIT	FunctionSettings (const String &id)
MAXON_IMPLICIT	FunctionSettings (const String &action, const String &id)
MAXON_IMPLICIT	FunctionSettings (const String &action, const String &id, Bool startup)

Public Attributes
String	_functionID
String	_actionID
Bool	_errorExpected
Bool	_startup

Constructor & Destructor Documentation

FunctionSettings() [1/4]

FunctionSettings

(

)

FunctionSettings() [2/4]

MAXON_IMPLICIT FunctionSettings

(

const String &

id

)

Constructor creating function settings from the given Action ID.

Parameters

[in]

id

The Action ID.

FunctionSettings() [3/4]

MAXON_IMPLICIT FunctionSettings	(	const String &	action,
		const String &	id
	)

Constructor creating function settings from the given Action ID and function ID. The preferred way to create a FunctionSettings object.

Parameters

[in]	action	The Action ID.
[in]	id	The function ID.

FunctionSettings() [4/4]

MAXON_IMPLICIT FunctionSettings	(	const String &	action,
		const String &	id,
		Bool	startup
	)

Constructor creating function settings from the given Action ID, function ID and startup status.

Parameters

[in]	action	The Action ID.
[in]	id	The function ID.
[in]	startup	The startup status (true if this function can be called on start-up).

Member Data Documentation

_functionID

String _functionID

ID of the function.

_actionID

String _actionID

ID of the host action.

_errorExpected

Bool _errorExpected

true if this function is expected to return an error.

_startup

Bool _startup

true if this function can be called on start-up (non-blocking, needs no active document etc.)