scriptedTaskMetaData.h File Reference

Go to the source code of this file.

Classes
class	DtScriptedTaskMetaData

Namespaces
namespace	DtBufferSerialize
	This namespace contains a set of utility functions for encoding and decoding various data types to/from a byte array.

Typedefs
typedef bool(*	DtEncryptDecryptFcn )(const std::string &scriptId, char *input, int inputLen, char **output, int &outputLen, bool encrypt, void *usr)
	Typedef for encrypt/decrypt function.

Functions
DT_DLL_vrfutil int	DtBufferSerialize::getSize (const DtScriptedTaskMetaData &v)
DT_DLL_vrfutil char *	DtBufferSerialize::encode (const DtScriptedTaskMetaData &val, char *buffer)
DT_DLL_vrfutil const char *	DtBufferSerialize::decode (DtScriptedTaskMetaData &val, const char *buffer)

Variables
const int	DtScriptedTaskScriptedTask = 1
	A class for keeping track of meta data for scripted tasks.
const int	DtScriptedTaskReactiveTask = 2
const int	DtScriptedTaskBackgroundProcess = 3
const int	DtScriptedTaskScriptedSet = 4
const int	DtScriptedTask_AvailableToAllDoctrines = 0x00000001
const int	DtScriptedTask_ShowOnTopLevelRightClickMenu = 0x00000002
const int	DtScriptedTask_UseUiFile = 0x00000004

Detailed Description

Typedef Documentation

typedef bool(* DtEncryptDecryptFcn)(const std::string &scriptId, char *input, int inputLen, char **output, int &outputLen, bool encrypt, void *usr)

Typedef for encrypt/decrypt function.

The buffer returned either from encryption or decryption MUST be a plain string so it can be written to a file. The function will return true if the buffer is encrypted or decrypted successfully. Scripts that are encrypted and not decrypted successfully will be left blank. The output buffer must be deallocated by the caller. It is assumed allocated via a new char[length] call. If no output buffer is supplied, the output len will simply be what the buffer would be if encrypted or decrypted.

Variable Documentation

const int DtScriptedTaskScriptedTask = 1

A class for keeping track of meta data for scripted tasks.

The information is currently stored in an XML format

Referenced by DtScriptedTaskMetaData::serialize().

const int DtScriptedTaskReactiveTask = 2

const int DtScriptedTaskBackgroundProcess = 3

const int DtScriptedTaskScriptedSet = 4

const int DtScriptedTask_AvailableToAllDoctrines = 0x00000001

Referenced by DtScriptedTaskMetaData::serialize().

const int DtScriptedTask_ShowOnTopLevelRightClickMenu = 0x00000002

const int DtScriptedTask_UseUiFile = 0x00000004