visit Kofax web site

SPPropertyMap.h File Reference


Detailed Description

SignWare Dynamic Development toolkit, Property Map.

Author:
uko
A Property map presents a container of one or more property values. A Property may be of type SPINT32, SPDOUBLE, SPFLOAT, SPCHAR *, or SPUCHAR *. Property maps are serializable.


Functions

SPINT32 __cdecl SPPropertyMapClone (pSPPROPERTYMAP_T pPropertyMap, pSPPROPERTYMAP_T *ppClone)
 Create a copy of a Property map object.
SPINT32 __cdecl SPPropertyMapCreate (pSPPROPERTYMAP_T *ppProperty)
 Create a Property map object.
SPINT32 __cdecl SPPropertyMapCreateFromFlatFile (pSPPROPERTYMAP_T *ppPropertyMap, const SPUCHAR *pbFlatFile, SPINT32 iFlatFileLen)
 Create an SPPropertyMap object from serialized data.
SPINT32 __cdecl SPPropertyMapEnumBool (pSPPROPERTYMAP_T pProperty, int iIndex, SPCHAR **ppszName, SPINT32 *paValue)
 Query the content of the nth bool property.
SPINT32 __cdecl SPPropertyMapEnumData (pSPPROPERTYMAP_T pProperty, int iIndex, SPCHAR **ppszName, SPUCHAR **ppucValue, SPINT32 *piValueLen)
 Query the content of the nth data property.
SPINT32 __cdecl SPPropertyMapEnumDouble (pSPPROPERTYMAP_T pProperty, int iIndex, SPCHAR **ppszName, SPDOUBLE *paValue)
 Query the content of the nth double property.
SPINT32 __cdecl SPPropertyMapEnumFloat (pSPPROPERTYMAP_T pProperty, int iIndex, SPCHAR **ppszName, SPFLOAT *paValue)
 Query the content of the nth float property.
SPINT32 __cdecl SPPropertyMapEnumInt (pSPPROPERTYMAP_T pProperty, int iIndex, SPCHAR **ppszName, SPINT32 *paValue)
 Query the content of the nth int property.
SPINT32 __cdecl SPPropertyMapEnumString (pSPPROPERTYMAP_T pProperty, int iIndex, SPCHAR **ppszName, SPCHAR **ppszValue)
 Query the content of the nth string property.
SPINT32 __cdecl SPPropertyMapEquals (pSPPROPERTYMAP_T pPropertyMap, SPVPTR pObject, SPBOOL *bEqual)
 Compare two PropertyMap objects.
SPINT32 __cdecl SPPropertyMapFree (pSPPROPERTYMAP_T *ppProperty)
 Free a PropertyMap object.
SPINT32 __cdecl SPPropertyMapGetBool (pSPPROPERTYMAP_T pProperty, const SPCHAR *pszName, SPINT32 *paValue)
 Query the content of a property.
SPINT32 __cdecl SPPropertyMapGetData (pSPPROPERTYMAP_T pProperty, const SPCHAR *pszName, SPUCHAR **ppucValue, SPINT32 *piValueLen)
 Query the string content of a property.
SPINT32 __cdecl SPPropertyMapGetDouble (pSPPROPERTYMAP_T pProperty, const SPCHAR *pszName, SPDOUBLE *paValue)
 Query the content of a property.
SPINT32 __cdecl SPPropertyMapGetFloat (pSPPROPERTYMAP_T pProperty, const SPCHAR *pszName, SPFLOAT *paValue)
 Query the content of a property.
SPINT32 __cdecl SPPropertyMapGetInt (pSPPROPERTYMAP_T pProperty, const SPCHAR *pszName, SPINT32 *paValue)
 Query the content of a property.
SPINT32 __cdecl SPPropertyMapGetNumberBool (pSPPROPERTYMAP_T pProperty, SPINT32 *paValue)
 query the number of bool properties in the SPPROPERTYMAP_T container
SPINT32 __cdecl SPPropertyMapGetNumberData (pSPPROPERTYMAP_T pProperty, SPINT32 *paValue)
 query the number of data properties in the SPPROPERTYMAP_T container
SPINT32 __cdecl SPPropertyMapGetNumberDouble (pSPPROPERTYMAP_T pProperty, SPINT32 *paValue)
 query the number of double properties in the SPPROPERTYMAP_T container
SPINT32 __cdecl SPPropertyMapGetNumberFloat (pSPPROPERTYMAP_T pProperty, SPINT32 *paValue)
 query the number of float properties in the SPPROPERTYMAP_T container
SPINT32 __cdecl SPPropertyMapGetNumberInt (pSPPROPERTYMAP_T pProperty, SPINT32 *paValue)
 query the number of int properties in the SPPROPERTYMAP_T container
SPINT32 __cdecl SPPropertyMapGetNumberString (pSPPROPERTYMAP_T pProperty, SPINT32 *paValue)
 query the number of string properties in the SPPROPERTYMAP_T container
SPINT32 __cdecl SPPropertyMapGetString (pSPPROPERTYMAP_T pProperty, const SPCHAR *pszName, SPCHAR **ppszValue)
 Query the string content of a property.
SPINT32 __cdecl SPPropertyMapRead (pSPPROPERTYMAP_T pProperty, const SPUCHAR *pData, SPINT32 *piDataLen)
 Deserialize an SPPropertyMap object from a buffer.
SPINT32 __cdecl SPPropertyMapSetBool (pSPPROPERTYMAP_T pProperty, const SPCHAR *pszName, SPINT32 aValue)
 Set the value of a property.
SPINT32 __cdecl SPPropertyMapSetData (pSPPROPERTYMAP_T pProperty, const SPCHAR *pszName, const SPUCHAR *pucValue, SPINT32 iValueLen)
 Set the string content of a property.
SPINT32 __cdecl SPPropertyMapSetDouble (pSPPROPERTYMAP_T pProperty, const SPCHAR *pszName, SPDOUBLE aValue)
 Set the value of a property.
SPINT32 __cdecl SPPropertyMapSetFloat (pSPPROPERTYMAP_T pProperty, const SPCHAR *pszName, SPFLOAT aValue)
 Set the value of a property.
SPINT32 __cdecl SPPropertyMapSetInt (pSPPROPERTYMAP_T pProperty, const SPCHAR *pszName, SPINT32 aValue)
 Set the value of a property.
SPINT32 __cdecl SPPropertyMapSetString (pSPPROPERTYMAP_T pProperty, const SPCHAR *pszName, const SPCHAR *pszValue)
 Set the string content of a property.
SPINT32 __cdecl SPPropertyMapString (pSPPROPERTYMAP_T pProperty, SPCHAR **ppResult)
 Query the string representation of this object.
SPINT32 __cdecl SPPropertyMapWrite (pSPPROPERTYMAP_T pProperty, SPUCHAR **ppData, SPINT32 *piDataLen)
 Serialize an SPPropertyMap object into a buffer.


Function Documentation

SPINT32 __cdecl SPPropertyMapClone pSPPROPERTYMAP_T  pPropertyMap,
pSPPROPERTYMAP_T ppClone
 

Create a copy of a Property map object.

Parameters:
pPropertyMap [i] the object to be cloned
ppClone [o] pointer to a pSPPROPERTYMAP_T object that will be filled with a valid instance of a PropertyMap object. The newly created object will be a true copy of pPropertyMap
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)

SPINT32 __cdecl SPPropertyMapCreate pSPPROPERTYMAP_T ppProperty  ) 
 

Create a Property map object.

Parameters:
ppProperty [o] pointer to a pSPPROPERTYMAP_T object that will be filled with a valid instance of a PropertyMap object
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)

SPINT32 __cdecl SPPropertyMapCreateFromFlatFile pSPPROPERTYMAP_T ppPropertyMap,
const SPUCHAR pbFlatFile,
SPINT32  iFlatFileLen
 

Create an SPPropertyMap object from serialized data.

This function deserializes an SPPropertyMap object serialized by SPFlatFileCreateFromPropertyMap.

In contrast to SPPropertyMapRead, this function creates a new SPPropertyMap object.

Parameters:
ppPropertyMap [o] pointer to a variable that will be filled with a pointer to a new SPPropertyMap object. The caller is responsible for deallocating the new object by calling SPPropertyMapFree.
pbFlatFile [i] pointer to an array of bytes containing a serialized SPPropertyMap object.
iFlatFileLen [i] length (in bytes) of the serialized data pointed to by pbFlatFile.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)
See also:
SPPropertyMapRead, SPFlatFileCreateFromPropertyMap

SPINT32 __cdecl SPPropertyMapEnumBool pSPPROPERTYMAP_T  pProperty,
int  iIndex,
SPCHAR **  ppszName,
SPINT32 paValue
 

Query the content of the nth bool property.

Parameters:
pProperty [i] pointer to a valid pSPPROPERTYMAP_T object
iIndex [i] zero based index
ppszName [io] pointer to a SPCHAR * that will be filled with the name of the property, use SPFreeString to free the allocated memory if you no longer need the name
paValue [io] pointer to a SPINT32 that will be filled with the value of the property
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)

SPINT32 __cdecl SPPropertyMapEnumData pSPPROPERTYMAP_T  pProperty,
int  iIndex,
SPCHAR **  ppszName,
SPUCHAR **  ppucValue,
SPINT32 piValueLen
 

Query the content of the nth data property.

Parameters:
pProperty [i] pointer to a valid pSPPROPERTYMAP_T object
iIndex [i] zero based index
ppszName [io] pointer to a SPCHAR * that will be filled with the name of the property, use SPFreeString to free the allocated memory if you no longer need the name
ppucValue [io] pointer to a SPUCHAR* that will be filled with the value of the property, call SPFreeString to free the value if it is no longer needed
piValueLen [o] will be filled with the length of the data in bytes
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)

SPINT32 __cdecl SPPropertyMapEnumDouble pSPPROPERTYMAP_T  pProperty,
int  iIndex,
SPCHAR **  ppszName,
SPDOUBLE paValue
 

Query the content of the nth double property.

Note:
Double and Float values are treated equal
Parameters:
pProperty [i] pointer to a valid pSPPROPERTYMAP_T object
iIndex [i] zero based index
ppszName [io] pointer to a SPCHAR * that will be filled with the name of the property, use SPFreeString to free the allocated memory if you no longer need the name
paValue [io] pointer to a SPINT32 that will be filled with the value of the property
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)

SPINT32 __cdecl SPPropertyMapEnumFloat pSPPROPERTYMAP_T  pProperty,
int  iIndex,
SPCHAR **  ppszName,
SPFLOAT paValue
 

Query the content of the nth float property.

Note:
Double and Float values are treated equal
Parameters:
pProperty [i] pointer to a valid pSPPROPERTYMAP_T object
iIndex [i] zero based index
ppszName [io] pointer to a SPCHAR * that will be filled with the name of the property, use SPFreeString to free the allocated memory if you no longer need the name
paValue [io] pointer to a SPFLOAT that will be filled with the value of the property
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)

SPINT32 __cdecl SPPropertyMapEnumInt pSPPROPERTYMAP_T  pProperty,
int  iIndex,
SPCHAR **  ppszName,
SPINT32 paValue
 

Query the content of the nth int property.

Parameters:
pProperty [i] pointer to a valid pSPPROPERTYMAP_T object
iIndex [i] zero based index
ppszName [io] pointer to a SPCHAR * that will be filled with the name of the property, use SPFreeString to free the allocated memory if you no longer need the name
paValue [io] pointer to a SPINT32 that will be filled with the value of the property
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)

SPINT32 __cdecl SPPropertyMapEnumString pSPPROPERTYMAP_T  pProperty,
int  iIndex,
SPCHAR **  ppszName,
SPCHAR **  ppszValue
 

Query the content of the nth string property.

Parameters:
pProperty [i] pointer to a valid pSPPROPERTYMAP_T object
iIndex [i] zero based index
ppszName [io] pointer to a SPCHAR * that will be filled with the name of the property, use SPFreeString to free the allocated memory if you no longer need the name
ppszValue [io] pointer to a SPCHAR that will be filled with the (zero terminated) value of the property, call SPFreeString to free the memory if the value is no longer needed
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)

SPINT32 __cdecl SPPropertyMapEquals pSPPROPERTYMAP_T  pPropertyMap,
SPVPTR  pObject,
SPBOOL bEqual
 

Compare two PropertyMap objects.

Parameters:
pPropertyMap [i] pointer to a valid pSPPROPERTYMAP_T object
pObject [i] pointer to a Signware object
bEqual [o] pointer to a variable that will be set to true is both objects are equal
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)

SPINT32 __cdecl SPPropertyMapFree pSPPROPERTYMAP_T ppProperty  ) 
 

Free a PropertyMap object.

Parameters:
ppProperty [io] pointer to a valid pSPPROPERTYMAP_T object
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)

SPINT32 __cdecl SPPropertyMapGetBool pSPPROPERTYMAP_T  pProperty,
const SPCHAR pszName,
SPINT32 paValue
 

Query the content of a property.

Parameters:
pProperty [i] pointer to a valid pSPPROPERTYMAP_T object
pszName [i] the name of the property
paValue [o] pointer to an integer that will be filled with the contents of the property.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)

SPINT32 __cdecl SPPropertyMapGetData pSPPROPERTYMAP_T  pProperty,
const SPCHAR pszName,
SPUCHAR **  ppucValue,
SPINT32 piValueLen
 

Query the string content of a property.

Use SPFreeMemory to free the returned data.

Parameters:
pProperty [i] pointer to a valid pSPPROPERTYMAP_T object
pszName [i] the name of the property
ppucValue [o] pointer to a char pointer that will be filled with the contents of the property. Memory will be allocated as required. Use SPFreeString to free the allocated memory.
piValueLen [o] will be filled with the length of the data in bytes
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)

SPINT32 __cdecl SPPropertyMapGetDouble pSPPROPERTYMAP_T  pProperty,
const SPCHAR pszName,
SPDOUBLE paValue
 

Query the content of a property.

Parameters:
pProperty [i] pointer to a valid pSPPROPERTYMAP_T object
pszName [i] the name of the property
paValue [o] pointer to a double that will be filled with the contents of the property.
Returns:
SP_NOERR on success, else error code:
  • SP_PARAMERR undefined property or not a double and not an integer
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)

SPINT32 __cdecl SPPropertyMapGetFloat pSPPROPERTYMAP_T  pProperty,
const SPCHAR pszName,
SPFLOAT paValue
 

Query the content of a property.

Parameters:
pProperty [i] pointer to a valid pSPPROPERTYMAP_T object
pszName [i] the name of the property
paValue [o] pointer to a float that will be filled with the contents of the property.
Returns:
SP_NOERR on success, else error code:
  • SP_PARAMERR undefined property or not a float and not an integer
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)

SPINT32 __cdecl SPPropertyMapGetInt pSPPROPERTYMAP_T  pProperty,
const SPCHAR pszName,
SPINT32 paValue
 

Query the content of a property.

Parameters:
pProperty [i] pointer to a valid pSPPROPERTYMAP_T object
pszName [i] the name of the property
paValue [o] pointer to an integer that will be filled with the contents of the property.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)

SPINT32 __cdecl SPPropertyMapGetNumberBool pSPPROPERTYMAP_T  pProperty,
SPINT32 paValue
 

query the number of bool properties in the SPPROPERTYMAP_T container

Parameters:
pProperty [i] pointer to a valid pSPPROPERTYMAP_T object
paValue [io] pointer to a SPINT32 object that will be filled with the number of properties
Returns:
SP_NOERR on success
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)

SPINT32 __cdecl SPPropertyMapGetNumberData pSPPROPERTYMAP_T  pProperty,
SPINT32 paValue
 

query the number of data properties in the SPPROPERTYMAP_T container

Parameters:
pProperty [i] pointer to a valid pSPPROPERTYMAP_T object
paValue [io] pointer to a SPINT32 object that will be filled with the number of properties
Returns:
SP_NOERR on success
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)

SPINT32 __cdecl SPPropertyMapGetNumberDouble pSPPROPERTYMAP_T  pProperty,
SPINT32 paValue
 

query the number of double properties in the SPPROPERTYMAP_T container

Note:
Double and Float values are treated equal
Parameters:
pProperty [i] pointer to a valid pSPPROPERTYMAP_T object
paValue [io] pointer to a SPINT32 object that will be filled with the number of properties
Returns:
SP_NOERR on success
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)

SPINT32 __cdecl SPPropertyMapGetNumberFloat pSPPROPERTYMAP_T  pProperty,
SPINT32 paValue
 

query the number of float properties in the SPPROPERTYMAP_T container

Note:
Double and Float values are treated equal
Parameters:
pProperty [i] pointer to a valid pSPPROPERTYMAP_T object
paValue [io] pointer to a SPINT32 object that will be filled with the number of properties
Returns:
SP_NOERR on success
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)

SPINT32 __cdecl SPPropertyMapGetNumberInt pSPPROPERTYMAP_T  pProperty,
SPINT32 paValue
 

query the number of int properties in the SPPROPERTYMAP_T container

Parameters:
pProperty [i] pointer to a valid pSPPROPERTYMAP_T object
paValue [io] pointer to a SPINT32 object that will be filled with the number of properties
Returns:
SP_NOERR on success
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)

SPINT32 __cdecl SPPropertyMapGetNumberString pSPPROPERTYMAP_T  pProperty,
SPINT32 paValue
 

query the number of string properties in the SPPROPERTYMAP_T container

Parameters:
pProperty [i] pointer to a valid pSPPROPERTYMAP_T object
paValue [io] pointer to a SPINT32 object that will be filled with the number of properties
Returns:
SP_NOERR on success
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)

SPINT32 __cdecl SPPropertyMapGetString pSPPROPERTYMAP_T  pProperty,
const SPCHAR pszName,
SPCHAR **  ppszValue
 

Query the string content of a property.

Use SPFreeString to free the returned string.

Parameters:
pProperty [i] pointer to a valid pSPPROPERTYMAP_T object
pszName [i] the name of the property
ppszValue [o] pointer to a char pointer that will be filled with the contents of the property. Memory will be allocated as required. Use SPFreeString to free the allocated memory.
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)

SPINT32 __cdecl SPPropertyMapRead pSPPROPERTYMAP_T  pProperty,
const SPUCHAR pData,
SPINT32 piDataLen
 

Deserialize an SPPropertyMap object from a buffer.

Parameters:
pProperty [i] a valid pSPPROPERTYMAP_T object
pData [i] a buffer that contains the serialized data
piDataLen [io] pointer to an integer that contains the length of the buffer on entry, and will be filled with the number of bytes actually read from the buffer
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)

SPINT32 __cdecl SPPropertyMapSetBool pSPPROPERTYMAP_T  pProperty,
const SPCHAR pszName,
SPINT32  aValue
 

Set the value of a property.

Parameters:
pProperty [i] pointer to a valid pSPPROPERTYMAP_T object
pszName [i] the name of the property
aValue [i] the value of the property
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)

SPINT32 __cdecl SPPropertyMapSetData pSPPROPERTYMAP_T  pProperty,
const SPCHAR pszName,
const SPUCHAR pucValue,
SPINT32  iValueLen
 

Set the string content of a property.

Use SPFreeString to free the returned string.

Parameters:
pProperty [i] pointer to a valid pSPPROPERTYMAP_T object
pszName [i] the name of the property
pucValue [i] pointer to the data that should be passed to the property
iValueLen [i] length of the data in bytes
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)

SPINT32 __cdecl SPPropertyMapSetDouble pSPPROPERTYMAP_T  pProperty,
const SPCHAR pszName,
SPDOUBLE  aValue
 

Set the value of a property.

Parameters:
pProperty [i] pointer to a valid pSPPROPERTYMAP_T object
pszName [i] the name of the property
aValue [i] the value of the property
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)

SPINT32 __cdecl SPPropertyMapSetFloat pSPPROPERTYMAP_T  pProperty,
const SPCHAR pszName,
SPFLOAT  aValue
 

Set the value of a property.

Parameters:
pProperty [i] pointer to a valid pSPPROPERTYMAP_T object
pszName [i] the name of the property
aValue [i] the value of the property
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)

SPINT32 __cdecl SPPropertyMapSetInt pSPPROPERTYMAP_T  pProperty,
const SPCHAR pszName,
SPINT32  aValue
 

Set the value of a property.

Parameters:
pProperty [i] pointer to a valid pSPPROPERTYMAP_T object
pszName [i] the name of the property
aValue [i] the value of the property
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)

SPINT32 __cdecl SPPropertyMapSetString pSPPROPERTYMAP_T  pProperty,
const SPCHAR pszName,
const SPCHAR pszValue
 

Set the string content of a property.

Use SPFreeString to free the returned string.

Parameters:
pProperty [i] pointer to a valid pSPPROPERTYMAP_T object
pszName [i] the name of the property
pszValue [i] pointer to the string that should be passed to the property
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)

SPINT32 __cdecl SPPropertyMapString pSPPROPERTYMAP_T  pProperty,
SPCHAR **  ppResult
 

Query the string representation of this object.

Use SPFreeString to free the resulting string.

Parameters:
pProperty [i] A valid pSPPROPERTYMAP_T object
ppResult [o] pointer to a string that will be filled with the string representation of this object
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)

SPINT32 __cdecl SPPropertyMapWrite pSPPROPERTYMAP_T  pProperty,
SPUCHAR **  ppData,
SPINT32 piDataLen
 

Serialize an SPPropertyMap object into a buffer.

Use SPFreeString to free the resulting data block if no longer needed.

Parameters:
pProperty [i] a valid pSPPROPERTYMAP_T object
ppData [o] pointer to a buffer that will be filled with the serialized data
piDataLen [o] pointer to an integer that will be filled with the length of the buffer
Returns:
SP_NOERR on success, else error code:
Operating Systems:
Windows (Win32), Linux (i386), Linux (x86_64), Linux (ARM), Android (ARMv7a), Darwin (x86_64)