TekStd Class Reference

Inheritance diagram for TekStd:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 TekStd ()
 ~TekStd ()
virtual unsigned int AddRef ()
virtual TEKERR CheckFor (const uuid_t *UUIDArray, size_t UUIDArraySize, unsigned short Flags=0x0000, void **RetVal=(void **) NULL, unsigned int **RefCountPtrRet=(unsigned int **) NULL)
virtual unsigned int Release ()
virtual TEKERR CallFunc (const uchar_t *FuncName, void *RetVal, unsigned short ParamsCount, void **Params)

Detailed Description

The official TekStd interface.

This interface defines the standard for, at minimum, passing interface pointers to something that is referencable to any function requiring an interface instantizable from the teklti library.

This interface is INHERITABLE.

Author:
Kevin McBride

Definition at line 1287 of file teklti.h.


Constructor & Destructor Documentation

TekStd TekStd  ) 
 

Instantizer.

Definition at line 42 of file TekStd.cpp.

~TekStd  ) 
 

Destructor.

Definition at line 51 of file TekStd.cpp.


Member Function Documentation

unsigned int AddRef  )  [virtual]
 

Adds a reference to the instance.

Definition at line 63 of file TekStd.cpp.

Referenced by CheckFor().

TEKERR CallFunc const uchar_t FuncName,
void *  RetVal,
unsigned short  ParamsCount,
void **  Params
[virtual]
 

Calls a function in the instance.
Useful when trying to test for a feature.
WARNING! Use of this function will cause speed to suffer!
In addition, it can't guarantee that a certain interface is
derived from TekStd.

Definition at line 189 of file TekStd.cpp.

TEKERR CheckFor const uuid_t *  UUIDArray,
size_t  UUIDArraySize,
unsigned short  Flags = 0x0000,
void **  RetVal = (void **) NULL,
unsigned int **  RefCountPtrRet = (unsigned int **) NULL
[virtual]
 

Checks the instance for support of a particular set of interfaces.

If RetVal != NULL and Flags are set to 1, then CheckFor() will create a pointer to the instance and set it in the memory reference provided by RetVal.

Unlike most functions, CheckFor() will return a TEKERR value based on the return condition:

  • On sucessful completion, a flat TEKERR_OK is returned in the TEKERR value.

  • If RetVal is NULL when Flags is 1, a flat TEKERR_POINTER may be returned in the TEKERR value.

  • If an element in UUIDArray is not found in __uuidarray, TEKERR will be set as follows:
    0x00020001
    Where 0x0001 is set to TEKERR_NOTIMPL, cast to an unsigned short.
    Where 0x0002 will be set to the array element causing the error.
    So, in the above example, it reads "UUIDArray[1] did not match anything in __uuidarray."
    TEKLTI_CHECKFOR_FAILING_ELEMENT(i) can be used to retrieve the element number, but only works when the TEKERR_NOTIMPL error occurs.

Definition at line 90 of file TekStd.cpp.

References AddRef().

Here is the call graph for this function:

unsigned int Release  )  [virtual]
 

Removes a reference to the instance.

Definition at line 171 of file TekStd.cpp.


The documentation for this class was generated from the following files: SourceForge.net Logo  Technical Library Template Interface Project Page