Engine base fundamental interface. More...

#include <DGLE.h>

Inheritance diagram for IDGLE_Base:

Public Member Functions
virtual DGLE_RESULT DGLE_API	GetGUID (GUID &guid)=0
	Returns unique identifier of the last interface in the inheritance chain.

virtual DGLE_RESULT DGLE_API	ExecuteCommand (uint uiCmd, TVariant &stVar)=0
	Executes some command using its index or bitmask.

virtual DGLE_RESULT DGLE_API	ExecuteTextCommand (const char *pcCommand, TVariant &stVar)=0
	Executes some text command and returns result as variant.

virtual DGLE_RESULT DGLE_API	ExecuteTextCommandEx (const char pcCommand, char pcResult, uint &uiCharsCount)=0
	Executes some text command and returns result as string.

Detailed Description

Engine base fundamental interface.

Any engine interface must be derived from this interface.

Attention: On Windows platform IDGLE_Base is derived from IUnknown for more flexibility and compatibility, but DGLE doesn't provides real COM technology. The reference counter is always 1, "Release" and "AddRef" methods are dummies, "QueryInterface" can return pointer only to IUnknown or to the last interface in the inheritance chain.

Member Function Documentation

virtual DGLE_RESULT DGLE_API ExecuteCommand	(	uint	uiCmd,
		TVariant &	stVar
	)

pure virtual

Executes some command using its index or bitmask.

Commands are specific for concrete interface. All commands should be described in documentation.

Parameters

[in]	uiCmd	Command index or some bitmask. These values must be gotten from documentation.
[in,out]	stVar	Variant with additional command parameters and for storing command result.

Note: If command returns any TVariant with allocated data inside then command with index -1 should delete any allocated memory inside interface.

virtual DGLE_RESULT DGLE_API ExecuteTextCommand	(	const char *	pcCommand,
		TVariant &	stVar
	)

pure virtual

Executes some text command and returns result as variant.

Commands are specific for concrete interface. All commands should be described in documentation.

Parameters

[in]	pcCommand	Pointer to allocated string with command.
[in,out]	stVar	Variant with additional command parameters and for storing command result.

virtual DGLE_RESULT DGLE_API ExecuteTextCommandEx	(	const char *	pcCommand,
		char *	pcResult,
		uint &	uiCharsCount
	)

pure virtual

Executes some text command and returns result as string.

Commands are specific for concrete interface. All commands should be described in documentation.

Parameters

[in]	pcCommand	Pointer to allocated string with command.
[out]	pcResult	Pointer to allocated string to accept command result.
[in,out]	uiCharsCount	Count of the chars in allocated result string.

Returns: E_INVALIDARG must be returned if allocated string is too small, uiCharsCount will contain required string length. E_NOTIMPL indicates that interface has not got any commands.

Note: If pcResult for command is NULL then uiCharsCount will contain recommended result string length and command should not be executed.

virtual DGLE_RESULT DGLE_API GetGUID ( GUID & guid )

pure virtual

Returns unique identifier of the last interface in the inheritance chain.

Parameters

[out] guid Unique interface identifier.