Main Page | Modules | Namespace List | Class Hierarchy | Class List | File List | Class Members | File Members

VXIvalue.h File Reference

#include "VXItypes.h"
#include "VXIheaderPrefix.h"
#include "VXIheaderSuffix.h"

Defines

#define VXIVALUE_API   SYMBOL_IMPORT_DECL
#define VXIArgs   VXIMap

Typedefs

typedef VXIint32 VXIvalueType
typedef enum VXIvalueResult VXIvalueResult
 Result codes for function methods.
typedef enum VXIValueStringFormat VXIValueStringFormat
 Formats for the string result of VXIValueToString, currently:.

Enumerations

enum  {
  VALUE_INTEGER = 0, VALUE_FLOAT = 1, VALUE_STRING = 2, VALUE_PTR = 3,
  VALUE_MAP = 4, VALUE_VECTOR = 5, VALUE_CONTENT = 6, VALUE_BOOLEAN = 7,
  VALUE_DOUBLE = 8, VALUE_LONG = 9, VALUE_ULONG = 10
}
enum  VXIvalueResult {
  VXIvalue_RESULT_FATAL_ERROR = -100, VXIvalue_RESULT_IO_ERROR = -8, VXIvalue_RESULT_OUT_OF_MEMORY = -7, VXIvalue_RESULT_SYSTEM_ERROR = -6,
  VXIvalue_RESULT_PLATFORM_ERROR = -5, VXIvalue_RESULT_BUFFER_TOO_SMALL = -4, VXIvalue_RESULT_INVALID_PROP_NAME = -3, VXIvalue_RESULT_INVALID_PROP_VALUE = -2,
  VXIvalue_RESULT_INVALID_ARGUMENT = -1, VXIvalue_RESULT_SUCCESS = 0, VXIvalue_RESULT_FAILURE = 1, VXIvalue_RESULT_NON_FATAL_ERROR = 2,
  VXIvalue_RESULT_UNSUPPORTED = 100
}
 Result codes for function methods. More...
enum  VXIValueStringFormat { VALUE_FORMAT_URL_QUERY_ARGS }
 Formats for the string result of VXIValueToString, currently:. More...

Functions

VXIVALUE_API VXIvalueType VXIValueGetType (const VXIValue *v)
 Get the type of a Value.
VXIVALUE_API void VXIValueDestroy (VXIValue **v)
 Generic Value destructor.
VXIVALUE_API VXIValue * VXIValueClone (const VXIValue *v)
 Generic Value clone.
VXIVALUE_API VXIBoolean * VXIBooleanCreate (VXIbool n)
 Create a Boolean from a VXIbool.
VXIVALUE_API void VXIBooleanDestroy (VXIBoolean **i)
 Boolean destructor.
VXIVALUE_API VXIbool VXIBooleanValue (const VXIBoolean *i)
 Get the value of a Boolean.
VXIVALUE_API VXIInteger * VXIIntegerCreate (VXIint32 n)
 Create an Integer from a 32 bit integer.
VXIVALUE_API void VXIIntegerDestroy (VXIInteger **i)
 Integer destructor.
VXIVALUE_API VXIint32 VXIIntegerValue (const VXIInteger *i)
 Get the value of an Integer.
VXIVALUE_API VXILong * VXILongCreate (VXIlong n)
 Create an Long from a 32 bit long.
VXIVALUE_API void VXILongDestroy (VXILong **i)
 Long destructor.
VXIVALUE_API VXIlong VXILongValue (const VXILong *i)
 Get the value of an Long.
VXIVALUE_API VXIULong * VXIULongCreate (VXIulong n)
 Create an ULong from a 32 bit unsigned long.
VXIVALUE_API void VXIULongDestroy (VXIULong **i)
 ULong destructor.
VXIVALUE_API VXIulong VXIULongValue (const VXIULong *i)
 Get the value of an ULong.
VXIVALUE_API VXIFloat * VXIFloatCreate (VXIflt32 n)
 Create a Float from a 32 bit floating point number.
VXIVALUE_API void VXIFloatDestroy (VXIFloat **f)
 Float destructor.
VXIVALUE_API VXIflt32 VXIFloatValue (const VXIFloat *f)
 Get the value of a Float.
VXIVALUE_API VXIDouble * VXIDoubleCreate (VXIflt64 n)
 Create a Double from a 32 bit floating point number.
VXIVALUE_API void VXIDoubleDestroy (VXIDouble **f)
 Double destructor.
VXIVALUE_API VXIflt64 VXIDoubleValue (const VXIDouble *f)
 Get the value of a Double.
VXIVALUE_API VXIPtr * VXIPtrCreate (void *n)
 Create a Ptr from a C pointer.
VXIVALUE_API void VXIPtrDestroy (VXIPtr **p)
 Ptr destructor.
VXIVALUE_API void * VXIPtrValue (const VXIPtr *p)
 Get the value of a Ptr.
VXIVALUE_API VXIContent * VXIContentCreate (const VXIchar *contentType, VXIbyte *content, VXIulong contentSizeBytes, void(*Destroy)(VXIbyte **content, void *userData), void *userData)
 Create a Content from MIME content typed data.
VXIVALUE_API VXIContent * VXIContentCreateEx (const VXIchar *contentType, VXIbyte *content, VXIulong contentSizeBytes, void(*Destroy)(VXIbyte **content, void *userData), void(*GetValue)(void *userData, const VXIbyte *currcontent, const VXIbyte **realcontent, VXIulong *realcontentSizeBytes), void *userData)
 Create a Content from MIME content typed data.
VXIVALUE_API void VXIContentGetUserData (const VXIContent *c, void **u)
 Retrieve the unique data pointer they passed to VXIContentCreate.
VXIVALUE_API void VXIContentSetTransferEncoding (const VXIContent *c, const VXIchar *e)
 Set the Content-Transfer-Encoding for MIME.
VXIVALUE_API const VXIcharVXIContentGetTransferEncoding (const VXIContent *c)
 Retrieve the Content-Transfer-Encoding for MIME.
VXIVALUE_API VXIulong VXIContentGetContentSizeBytes (const VXIContent *c)
 Retrieve the content size (in bytes).
VXIVALUE_API void VXIContentDestroy (VXIContent **c)
 Content destructor.
VXIVALUE_API VXIvalueResult VXIContentValue (const VXIContent *c, const VXIchar **contentType, const VXIbyte **content, VXIulong *contentSizeBytes)
 Get the value of a Content.
VXIVALUE_API VXIString * VXIStringCreate (const VXIchar *str)
 Create a String from a null-terminated character array.
VXIVALUE_API VXIString * VXIStringCreateN (const VXIchar *str, VXIunsigned len)
 Create a String from a known-length character array.
VXIVALUE_API void VXIStringDestroy (VXIString **s)
 String destructor.
VXIVALUE_API VXIString * VXIStringClone (const VXIString *s)
 String clone.
VXIVALUE_API VXIvalueResult VXIStringSetValue (VXIString *s, const VXIchar *str)
 Set the value of a String from a null-terminated character array.
VXIVALUE_API VXIcharVXIStringValue (const VXIString *s, VXIchar *buf, VXIunsigned len)
 Get the value of a String.
VXIVALUE_API const VXIcharVXIStringCStr (const VXIString *s)
 Get direct access to the NULL-terminated character value.
VXIVALUE_API VXIunsigned VXIStringLength (const VXIString *s)
 Get the number of characters in a String's value.
VXIVALUE_API VXIint VXIStringCompare (const VXIString *s1, const VXIString *s2)
 Compares two Strings.
VXIVALUE_API VXIint VXIStringCompareC (const VXIString *str, const VXIchar *buf)
 Compares a String to a NULL-terminated character array.
VXIVALUE_API VXIMap * VXIMapCreate (void)
 Create an empty Map.
VXIVALUE_API void VXIMapClear (VXIMap *m)
 Clear the content of the map and return an empty Map.
VXIVALUE_API void VXIMapDestroy (VXIMap **m)
 Map destructor.
VXIVALUE_API VXIMap * VXIMapClone (const VXIMap *m)
 Map clone.
VXIVALUE_API VXIvalueResult VXIMapSetProperty (VXIMap *m, const VXIchar *key, VXIValue *val)
 Set a named property on an Map.
VXIVALUE_API const VXIValue * VXIMapGetProperty (const VXIMap *m, const VXIchar *key)
 Get a named property from an Map.
VXIVALUE_API VXIvalueResult VXIMapDeleteProperty (VXIMap *m, const VXIchar *key)
 Delete a named property from an Map.
VXIVALUE_API VXIunsigned VXIMapNumProperties (const VXIMap *m)
 Return the number of properties for an Map.
VXIVALUE_API VXIMapIterator * VXIMapGetFirstProperty (const VXIMap *m, const VXIchar **key, const VXIValue **value)
 Get the first property of an Map and an iterator.
VXIVALUE_API VXIvalueResult VXIMapGetNextProperty (VXIMapIterator *it, const VXIchar **key, const VXIValue **value)
 Get the next property of an Map based on an iterator.
VXIVALUE_API void VXIMapIteratorDestroy (VXIMapIterator **it)
 Destroy an iterator.
VXIVALUE_API VXIVector * VXIVectorCreate (void)
 Create an empty Vector.
VXIVALUE_API void VXIVectorDestroy (VXIVector **v)
 Vector destructor.
VXIVALUE_API VXIVector * VXIVectorClone (const VXIVector *v)
 Vector clone.
VXIVALUE_API VXIvalueResult VXIVectorAddElement (VXIVector *v, VXIValue *val)
 Adds an element to the end of the Vector.
VXIVALUE_API VXIvalueResult VXIVectorSetElement (VXIVector *v, VXIunsigned n, VXIValue *val)
 Set an indexed vector element.
VXIVALUE_API const VXIValue * VXIVectorGetElement (const VXIVector *v, VXIunsigned n)
 Get an indexed vector element.
VXIVALUE_API VXIunsigned VXIVectorLength (const VXIVector *v)
 Return number of elements in a Vector.
VXIVALUE_API VXIString * VXIValueToString (const VXIValue *v, const VXIchar *name, VXIValueStringFormat format)
 Generic Value to string conversion.


Define Documentation

#define VXIVALUE_API   SYMBOL_IMPORT_DECL
 


Generated on Wed Jun 1 12:50:19 2005 for OpenVXI by  doxygen 1.4.2