orxResource.h File Reference

#include "orxInclude.h"

Go to the source code of this file.

Data Structures
struct	orxRESOURCE_EVENT_PAYLOAD
struct	orxRESOURCE_TYPE_INFO

Macros
#define	orxRESOURCE_KC_LOCATION_SEPARATOR   ':'
#define	orxRESOURCE_KZ_CONFIG_SECTION   "Resource"
#define	orxRESOURCE_KZ_CONFIG_WATCH_LIST   "WatchList"
#define	orxRESOURCE_KZ_DEFAULT_STORAGE   "."
#define	orxRESOURCE_KZ_TYPE_TAG_FILE   "file"
#define	orxRESOURCE_KZ_TYPE_TAG_MEMORY   "mem"

Typedefs
typedef void(orxFASTCALL *	orxRESOURCE_FUNCTION_CLOSE) (orxHANDLE _hResource)
typedef orxSTATUS(orxFASTCALL *	orxRESOURCE_FUNCTION_DELETE) (const orxSTRING _zLocation)
typedef orxS64(orxFASTCALL *	orxRESOURCE_FUNCTION_GET_SIZE) (orxHANDLE _hResource)
typedef orxS64(orxFASTCALL *	orxRESOURCE_FUNCTION_GET_TIME) (const orxSTRING _zLocation)
typedef const orxSTRING(orxFASTCALL *	orxRESOURCE_FUNCTION_LOCATE) (const orxSTRING _zGroup, const orxSTRING _zStorage, const orxSTRING _zName, orxBOOL _bRequireExistence)
typedef orxHANDLE(orxFASTCALL *	orxRESOURCE_FUNCTION_OPEN) (const orxSTRING _zLocation, orxBOOL _bEraseMode)
typedef orxS64(orxFASTCALL *	orxRESOURCE_FUNCTION_READ) (orxHANDLE _hResource, orxS64 _s64Size, void *_pBuffer)
typedef orxS64(orxFASTCALL *	orxRESOURCE_FUNCTION_SEEK) (orxHANDLE _hResource, orxS64 _s64Offset, orxSEEK_OFFSET_WHENCE _eWhence)
typedef orxS64(orxFASTCALL *	orxRESOURCE_FUNCTION_TELL) (orxHANDLE _hResource)
typedef orxS64(orxFASTCALL *	orxRESOURCE_FUNCTION_WRITE) (orxHANDLE _hResource, orxS64 _s64Size, const void *_pBuffer)
typedef void(orxFASTCALL *	orxRESOURCE_OP_FUNCTION) (orxHANDLE _hResource, orxS64 _s64Size, void *_pBuffer, void *_pContext)

Enumerations
enum	orxRESOURCE_EVENT {   orxRESOURCE_EVENT_UPDATE = 0 , orxRESOURCE_EVENT_ADD , orxRESOURCE_EVENT_REMOVE , orxRESOURCE_EVENT_NUMBER ,   orxRESOURCE_EVENT_NONE = orxENUM_NONE }

Functions
orxDLLAPI orxSTATUS orxFASTCALL	orxResource_AddStorage (const orxSTRING _zGroup, const orxSTRING _zStorage, orxBOOL _bAddFirst)
orxDLLAPI orxSTATUS orxFASTCALL	orxResource_ClearCache (const orxSTRING _zGroup)
orxDLLAPI void orxFASTCALL	orxResource_Close (orxHANDLE _hResource)
orxDLLAPI orxSTATUS orxFASTCALL	orxResource_Delete (const orxSTRING _zLocation)
orxDLLAPI void orxFASTCALL	orxResource_Exit ()
orxDLLAPI orxU32 orxFASTCALL	orxResource_GetCacheCount (const orxSTRING _zGroup)
orxDLLAPI const orxSTRING orxFASTCALL	orxResource_GetGroup (orxU32 _u32Index)
orxDLLAPI orxU32 orxFASTCALL	orxResource_GetGroupCount ()
orxDLLAPI const orxSTRING orxFASTCALL	orxResource_GetLocation (orxHANDLE _hResource)
orxDLLAPI orxHANDLE orxFASTCALL	orxResource_GetNextCachedLocation (const orxSTRING _zGroup, orxHANDLE _hIterator, const orxSTRING *_pzLocation, const orxSTRING *_pzStorage, const orxSTRING *_pzName)
orxDLLAPI const orxSTRING orxFASTCALL	orxResource_GetPath (const orxSTRING _zLocation)
orxDLLAPI orxU32 orxFASTCALL	orxResource_GetPendingOpCount (const orxHANDLE _hResource)
orxDLLAPI orxS64 orxFASTCALL	orxResource_GetSize (orxHANDLE _hResource)
orxDLLAPI const orxSTRING orxFASTCALL	orxResource_GetStorage (const orxSTRING _zGroup, orxU32 _u32Index)
orxDLLAPI orxU32 orxFASTCALL	orxResource_GetStorageCount (const orxSTRING _zGroup)
orxDLLAPI orxS64 orxFASTCALL	orxResource_GetTime (const orxSTRING _zLocation)
orxDLLAPI orxU32 orxFASTCALL	orxResource_GetTotalPendingOpCount ()
orxDLLAPI const orxRESOURCE_TYPE_INFO *orxFASTCALL	orxResource_GetType (const orxSTRING _zLocation)
orxDLLAPI orxU32 orxFASTCALL	orxResource_GetTypeCount ()
orxDLLAPI const orxSTRING orxFASTCALL	orxResource_GetTypeTag (orxU32 _u32Index)
orxDLLAPI orxSTATUS orxFASTCALL	orxResource_Init ()
orxDLLAPI const orxSTRING orxFASTCALL	orxResource_Locate (const orxSTRING _zGroup, const orxSTRING _zName)
orxDLLAPI const orxSTRING orxFASTCALL	orxResource_LocateInStorage (const orxSTRING _zGroup, const orxSTRING _zStorage, const orxSTRING _zName)
orxDLLAPI orxHANDLE orxFASTCALL	orxResource_Open (const orxSTRING _zLocation, orxBOOL _bEraseMode)
orxDLLAPI orxS64 orxFASTCALL	orxResource_Read (orxHANDLE _hResource, orxS64 _s64Size, void *_pBuffer, orxRESOURCE_OP_FUNCTION _pfnCallback, void *_pContext)
orxDLLAPI orxSTATUS orxFASTCALL	orxResource_RegisterType (const orxRESOURCE_TYPE_INFO *_pstInfo)
orxDLLAPI orxSTATUS orxFASTCALL	orxResource_ReloadStorage ()
orxDLLAPI orxSTATUS orxFASTCALL	orxResource_RemoveStorage (const orxSTRING _zGroup, const orxSTRING _zStorage)
orxDLLAPI orxS64 orxFASTCALL	orxResource_Seek (orxHANDLE _hResource, orxS64 _s64Offset, orxSEEK_OFFSET_WHENCE _eWhence)
orxDLLAPI orxSTATUS orxFASTCALL	orxResource_SetMemoryResource (const orxSTRING _zGroup, const orxSTRING _zStorage, const orxSTRING _zName, orxS64 _s64Size, const void *_pBuffer)
orxDLLAPI void orxFASTCALL	orxResource_Setup ()
orxDLLAPI orxSTATUS orxFASTCALL	orxResource_Sync (const orxSTRING _zGroup)
orxDLLAPI orxS64 orxFASTCALL	orxResource_Tell (orxHANDLE _hResource)
orxDLLAPI orxSTATUS orxFASTCALL	orxResource_UnregisterType (const orxSTRING _zTypeTag)
orxDLLAPI orxS64 orxFASTCALL	orxResource_Write (orxHANDLE _hResource, orxS64 _s64Size, const void *_pBuffer, orxRESOURCE_OP_FUNCTION _pfnCallback, void *_pContext)

Detailed Description

Date

20/01/2013

Author

iarwa.nosp@m.in@o.nosp@m.rx-pr.nosp@m.ojec.nosp@m.t.org

Definition in file orxResource.h.