Class RAnimDll

RAnimDll

Support

Supported from 5.0

Description

Client-side interface to the server-side animation DLL.

This is the client side class matching the server side CAnimDLL class. It provides functions to create, load, close, and destroy a server-side CAnimDll object.

Derivation

MWsClientClass Base class for all classes whose objects are clients of the window server engine RAnimDll Client-side interface to the server-side animation DLL

Defined in RAnimDll:
Close(), Destroy(), Load(), RAnimDll(), ~RAnimDll()

Inherited from MWsClientClass:
WsHandle()

See also:

• ::CreateCAnimDllL()
• CAnimDll

RAnimDll();

Description

Default constructor.

RAnimDll is a lightweight class which can be allocated as a non-pointer member. This constructor is provided to allow such a member to be instantiated while its owner is constructed.

Note that an RAnimDll constructed without a reference to a window server session is invalid.

RAnimDll(RWsSession& aWs);

Description

Valid constructor.

To be useable, an animation DLL should always be constructed with a reference to a window server session as argument.

Parameters

RWsSession &aWs Window server session to use.

virtual ~RAnimDll();

Description

Empty virtual destructor.

Destroy() should be used to instead of this function to destroy both this object and the server-side CAnimDll object.

See also:

• Destroy()
• Close()

virtual void Close();

Description

Closes an animation DLL.

Use this function to close a polymorphic DLL which was previously loaded on the server. Cleans up and frees all resources belonging to the DLL but does not delete it. Closing is in accordance with the RLibrary mechanism.

Load() and Close() are symmetrical operations. A DLL can be re-loaded after a close has been called on it.

To both close and delete a previously loaded DLL, use Destroy().

void Destroy();

Description

Closes and deletes a previously loaded polymorphic DLL.

This function is equivalent to calling this->Close() followed by delete this, in accordance with the RLibrary mechanism provided for managing polymorphic DLLs.

TInt Load(const TDesC& aFileName);

Description

Instructs the server to load an animation DLL.

Use this function to pass the name of a polymorphic DLL, the animation DLL, for loading on the server side. Loading is in accordance with the RLibrary mechanism. The DLL must conform to the interface defined by the window server, otherwise an error will result. For requirements, see the description of CAnimDll.

Load() and Close() are symmetrical operations. A DLL can be re-loaded after a close has been called on it.

Parameters

const TDesC &aFileName Filename of the DLL to load.

Return value

TInt KErrNone if successful, otherwise one of the system-wide error codes.