Datatypes


Result Codes

All interface methods which have tresult as return type must return kResultOk to indicate success, or one of the following result codes in case of error:

kResultOk Everything fine
kNoInterface Requested interface not implemented
Only used in FUnknown::queryInterface
kResultTrue Same as kResultOk
kResultFalse False, no further details
kInvalidArgument The caller passed on an invalid argument
kNotImplemented Function is not implemented
kInternalError An internal error occured
kNotInitialized The object is not correctly initialized (IPluginBase::initialize not yet called).
kOutOfMemory Out of memory


FUID

Include File:  funknown.h

The SDK provides a C++ class FUID for handling 16 Byte Globaly Unique Identifiers.

Each interface declares its identifier as static member inside the interface namespace (e.g. FUnknown::iid).

Methods:


FUID::generate

bool generate ()

Generate a new Unique Identifier (UID). Will return true for success. If the return value is false, either no UID is generated or the UID is not guaranteed to be unique worldwide.


FUID::isValid

bool isValid ()

Check if the UID data is valid. The default constructor initializes the memory with zeros.


FUID::toString

void toString (char* string)

Convert UID to a string. The string will be 32 characters long, representing the hexadecimal values of each data byte (e.g. "9127BE30160E4BB69966670AA6087880").


FUID::fromString

bool fromString (const char* string)

Set the UID data from a string. The string has to be 32 characters long, where each character-pair is the ASCII-encoded hexadecimal value of the corresponding data byte.


FUID::toRegistryString

void toRegistryString (char* string)

Convert UID to a string in Microsoft® OLE format (e.g. "{c200e360-38c5-11ce-ae62-08002b2b79ef}").


FUID::fromRegistryString

bool fromRegistryString (char* string)

Set the UID data from a string in Microsoft® OLE format.


FUID::print

void print (char* string = 0, long style = kINLINE_UID)

Print the UID to a string (or debug output if string is NULL). The format can be FUID::kINLINE_UID, FUID::kDECLARE_UID or FUID::kFUID.


ViewRect

Include File:  iplugui.h

struct ViewRect
{
	long left;
	long top;
	long right;
	long bottom;
};



Last Modified: