vdsCommon.h File Reference
#include <stdlib.h>
Include dependency graph for vdsCommon.h:
This graph shows which files directly or indirectly include this file:
Data Structures | |
| struct | vdsFolderEntry |
| This data structure is used to iterate throught all objects in a folder. More... | |
| struct | vdsObjStatus |
| This data structure is used to retrieve the status of objects. More... | |
| struct | vdsInfo |
| This data structure is used to retrieve the status of the virtual data space. More... | |
Defines | |
| #define | VDSF_EXPORT |
| Uses to tell the VC++ compiler to export/import a function or variable on Windows (the macro is empty on other platforms). | |
| #define | VDS_MAX_NAME_LENGTH 256 |
| Maximum number of characters (or bytes if not supporting i18n) of the name of a vds object (not counting the name of the parent folder(s)). | |
| #define | VDS_MAX_FULL_NAME_LENGTH 1024 |
| Maximum number of characters (or bytes if not supporting i18n) of the fully qualified name of a vds object (including the name(s) of its parent folder(s)). | |
Typedefs | |
| typedef void * | VDS_HANDLE |
| VDS_HANDLE is an opaque data type used by the C API to reference objects created in the API module. | |
| typedef enum vdsObjectType | vdsObjectType |
| typedef enum vdsIteratorType | vdsIteratorType |
| typedef vdsFolderEntry | vdsFolderEntry |
| typedef vdsObjStatus | vdsObjStatus |
| typedef vdsInfo | vdsInfo |
Enumerations | |
| enum | vdsObjectType { VDS_FOLDER = 1, VDS_QUEUE = 2, VDS_HASH_MAP = 3, VDS_LAST_OBJECT_TYPE } |
| The object type as seen from the API. More... | |
| enum | vdsIteratorType { VDS_FIRST = 1, VDS_NEXT = 2 } |
Define Documentation
| #define VDS_MAX_FULL_NAME_LENGTH 1024 |
Maximum number of characters (or bytes if not supporting i18n) of the fully qualified name of a vds object (including the name(s) of its parent folder(s)).
If the software was compiled with i18n, this maximum is the number of wide characters (4 bytes). Otherwise it is the number of bytes (which should equal the number of characters unless something funny is going on like using UTF-8 as locale and using ---disable-i18n with configure...).
Note: setting this value eliminates a possible loophole since some heap memory must be allocated to hold the wide characters string for the duration of the operation (open, close, create or destroy).
| #define VDS_MAX_NAME_LENGTH 256 |
Maximum number of characters (or bytes if not supporting i18n) of the name of a vds object (not counting the name of the parent folder(s)).
If the software was compiled with i18n, this maximum is the number of wide characters (4 bytes). Otherwise it is the number of bytes (which should equal the number of characters unless something funny is going on like using UTF-8 as locale and using ---disable-i18n with configure...).
| #define VDSF_EXPORT |
Uses to tell the VC++ compiler to export/import a function or variable on Windows (the macro is empty on other platforms).
Typedef Documentation
| typedef void* VDS_HANDLE |
VDS_HANDLE is an opaque data type used by the C API to reference objects created in the API module.
| typedef struct vdsFolderEntry vdsFolderEntry |
| typedef enum vdsIteratorType vdsIteratorType |
| typedef enum vdsObjectType vdsObjectType |
| typedef struct vdsObjStatus vdsObjStatus |
Enumeration Type Documentation
| enum vdsIteratorType |
| enum vdsObjectType |
Last updated on April 07, 2008.
