TekGlobalVars Class Reference

List of all members.

Public Member Functions

TEKLTI_DECLSPEC TEKERR TekFileCreate (TekFileType FileType, TekFile **RetVal, uchar_t *FileName=(uchar_t *) NULL)
TEKLTI_DECLSPEC TEKERR TekUserInfoCreate (struct TekUserInfo *UserInfo, TekUser **RetVal, TekUserType UserType=TekUserType_Any)
TEKERR TekStdCheckAndRecieveProcessorInfoIntel (struct TekStdProcessorInfoIntel *ProcessorInfoArray, size_t ProcessorInfoArrayCount, TEKSTDPROCESSORINFO_FAIL_CALLBACK *CallbackFunction)
TEKLTI_DECLSPEC TEKERR TekStdCreateInstance (CPTekStdCIInput InterfaceStructs, size_t InterfaceStructCount, void **InstanceArray, size_t InstanceArrayCount, const uuid_t *UUIDArray, size_t UUIDArrayCount, unsigned int Flags, PTekStdVersion VersionStruct)
TEKLTI_DECLSPEC TEKERR TekStdGetGlobalVariables (struct TekStdGlobalVars *RetVal)
TEKLTI_DECLSPEC TEKERR TekStdGetLibraryVersion (PTekStdVersion *VersionStruct, size_t VersionStructCount)
TEKLTI_DECLSPEC uchar_tchar2uchar (const char *src)
TEKLTI_DECLSPEC uchar_tchar2ucharlen (const char *src, size_t len)
TEKLTI_DECLSPEC uchar_tuchardup (const uchar_t *src)
TEKLTI_DECLSPEC void ucharempty (uchar_t *uchrtofree)
TEKLTI_DECLSPEC char * uchar2char (const uchar_t *uchr)
TEKLTI_DECLSPEC void mkucharnull (uchar_t *uchr, uint32_t extradw)

Detailed Description

Contains definitions for the Global Functions of libTekLTI.

NOTE: These functions are global functions, and as such, are not called from interfacing with nor creating instances of TekGlobalVars. As a result, this class serves simply to force doxygen to document the global functions in libTekLTI.

Author:
Kevin McBride

Definition at line 37 of file tekglobalvars.h.


Member Function Documentation

char2uchar const char *  src  ) 
 


This function converts an ASCII string into a uchar_t.

src - Pointer to an ASCII string.

Return value is uchar_t; will be NULL on failure.

char2ucharlen const char *  src,
size_t  len
 


This function converts len characters of an ASCII string into a uchar_t.

src - Pointer to an ASCII string.

len - Length of the ASCII string in sizeof(char)'s.

Return value is uchar_t; will be NULL on failure.

mkucharnull uchar_t uchr,
uint32_t  extradw
 

This macro fries a uchar_t structure.

extradw is currently unused.

CAUTION!!!!! This should only be used in situations where you are making the uchar_t without the help of the functions on this page!

TekFileCreate TekFileType  FileType,
TekFile **  RetVal,
uchar_t FileName = (uchar_t *)NULL
 


This function creates a new instance to an interface specified by FileType.

FileType - Identifies the type of interface to create a new instance out of.

RetVal - Pointer to a TekFile pointer to return the result in.

FileName: (Optional, default = NULL) Pointer to a FileName to associate with the new TekFile instance. If NULL, no Filename will be associated with the new instance.

TekStdCheckAndRecieveProcessorInfoIntel struct TekStdProcessorInfoIntel *  ProcessorInfoArray,
size_t  ProcessorInfoArrayCount,
TEKSTDPROCESSORINFO_FAIL_CALLBACK *  CallbackFunction
 


This function gets the processor info of the Intel processor. This function is compiled in libTekLTI only when TEKLTI_USE_386_ASM is defined during compilation.

ProcessorInfoArray - Arrays to fill in with processor info.

ProcessorInfoArrayCount - Array length of ProcessorInfoArray

CallbackFunction - Function to call to determine whether or not to call exit(). If NULL, and an error occurs, exit() will be called.
The format of the CallbackFunction is: int func(void)

TEKLTI_DECLSPEC TEKERR TekStdCreateInstance CPTekStdCIInput  InterfaceStructs,
size_t  InterfaceStructCount,
void **  InstanceArray,
size_t  InstanceArrayCount,
const uuid_t *  UUIDArray,
size_t  UUIDArrayCount,
unsigned int  Flags,
PTekStdVersion  VersionStruct
 


This function is still under construction.

TekStdGetGlobalVariables struct TekStdGlobalVars RetVal  ) 
 


This function obtains the global variables set in libTekLTI. You can use the variables to determine whether or not the library can be used by your program.

RetVal - Pointer to a structure to fill with the global variables.

TEKLTI_DECLSPEC TEKERR TekStdGetLibraryVersion PTekStdVersion VersionStruct,
size_t  VersionStructCount
[inline]
 


This function is still under construction.

Definition at line 142 of file tekglobalvars.h.

TekUserInfoCreate struct TekUserInfo UserInfo,
TekUser **  RetVal,
TekUserType  UserType = TekUserType_Any
 


This function creates a new instance to an interface specified by the UserType enumeration.

UserInfo - The structure of user information to pass in to the new instance.

RetVal - Pointer to a TekFile pointer to return the result in.

UserType: (Optional, default = TekUserInfo_Any) - The TekUser interface from the TekUserType enumeration to make an instance out of.

uchar2char const uchar_t uchr  ) 
 

This macro retrieves the C-style parameter of a uchar_t.

uchardup const uchar_t src  ) 
 


This function duplicates a uchar_t.

src - Pointer to a uchar_t.

Return value is uchar_t; will be NULL on failure.

ucharempty uchar_t src  ) 
 


This function frees a uchar_t from memory.

uchrtofree - Pointer to a uchar_t to free from memory.

This function returns nothing.

Under debugging scenarios, if uchrtofree == NULL, a SIGTRAP can be raised.


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