StringHash.h File Reference

OpenSOAP API StringHash Processing. More...

#include <OpenSOAP/String.h>

Go to the source code of this file.

Typedefs
typedef tagOpenSOAPStringHash	OpenSOAPStringHash
	OpenSOAPStringHash Structure Type Definition.
typedef OpenSOAPStringHash *	OpenSOAPStringHashPtr
	OpenSOAPStringHash Pointer Type Definition.
Functions
int	OpenSOAPStringHashCreate (OpenSOAPStringHashPtr *strh)
	Create OpenSOAPString Hash.
int	OpenSOAPStringHashRelease (OpenSOAPStringHashPtr strh)
	Release OpenSOAPString Hash.
int	OpenSOAPStringHashClear (OpenSOAPStringHashPtr strh)
	Clear OpenSOAPString Hash.
int	OpenSOAPStringHashRemoveKey (OpenSOAPStringHashPtr strh, OpenSOAPStringPtr key, void **val)
	Remove Key From OpenSOAPString Hash.
int	OpenSOAPStringHashSetValue (OpenSOAPStringHashPtr strh, OpenSOAPStringPtr key, void *val)
	Register Value In OpenSOAPString Hash.
int	OpenSOAPStringHashSetValueMB (OpenSOAPStringHashPtr strh, const char *key, void *val)
	Register Value In OpenSOAPString Hash.
int	OpenSOAPStringHashSetValueWC (OpenSOAPStringHashPtr strh, const wchar_t *key, void *val)
	Register Value In OpenSOAPString Hash.
int	OpenSOAPStringHashGetValue (OpenSOAPStringHashPtr strh, OpenSOAPStringPtr key, void **val)
	Get value from OpenSOAPString Hash.
int	OpenSOAPStringHashGetValueMB (OpenSOAPStringHashPtr strh, const char *key, void **val)
	Get value from OpenSOAPString Hash.
int	OpenSOAPStringHashGetValueWC (OpenSOAPStringHashPtr strh, const wchar_t *key, void **val)
	Get value from OpenSOAPString Hash.
int	OpenSOAPStringHashGetSize (OpenSOAPStringHashPtr strh, size_t *sz)
	Get Number Of OpenSOAPString Hash Registrations.
int	OpenSOAPStringHashGetKeys (OpenSOAPStringHashPtr strh, size_t *sz, OpenSOAPStringPtr *keys)
	Get OpenSOAPString Hash Keys(All).
int	OpenSOAPStringHashGetValues (OpenSOAPStringHashPtr strh, size_t *sz, void **vals)
	Get OpenSOAPString Hash Values(ALL).
int	OpenSOAPStringHashApplyToValues (OpenSOAPStringHashPtr strh, int(*aply)(void *, void *), void *opt)
	Apply all OpenSOAPString Hash registered values to specified function.

---

Detailed Description

OpenSOAP API StringHash Processing.

Author:

OpenSOAP Development Team

---

Function Documentation

int OpenSOAPStringHashApplyToValues (  OpenSOAPStringHashPtr  strh, int(*  aply)(void *, void *), void *  opt )

Apply all OpenSOAPString Hash registered values to specified function. Parameters: strh  OpenSOAPStringHashPtr [in] ((|strh|)) OpenSOAPString Hash aply()  int [in] ( * ((|aply|)) )(void *val, void *opt) Function Pointer. opt  void * [in] ((|opt|)) Option Parameters for function. Returns: Error Code

int OpenSOAPStringHashClear (  OpenSOAPStringHashPtr  strh  )

Clear OpenSOAPString Hash. Parameters: strh  OpenSOAPStringHashPtr [in, out] ((|strh|)) OpenSOAPString Hash Returns: Error Code

int OpenSOAPStringHashCreate (  OpenSOAPStringHashPtr *  strh  )

Create OpenSOAPString Hash. Parameters: strh  OpenSOAPStringHashPtr * [out] ((|strh|)) Created OpenSOAP String Hash Pointer Returns: Error Code

int OpenSOAPStringHashGetKeys (  OpenSOAPStringHashPtr  strh, size_t *  sz, OpenSOAPStringPtr *  keys )

Get OpenSOAPString Hash Keys(All). Parameters: strh  OpenSOAPStringHashPtr [in] ((|strh|)) OpenSOAPString Hash sz  size_t * [in, out] ((|sz|)) keys  OpenSOAPStringPtr * [out] ((|keys|)) Buffer containing registered keys Returns: Error Code

int OpenSOAPStringHashGetSize (  OpenSOAPStringHashPtr  strh, size_t *  sz )

Get Number Of OpenSOAPString Hash Registrations. Parameters: strh  OpenSOAPStringHashPtr [in] ((|strh|)) OpenSOAPString Hash sz  size_t * [out] ((|sz|)) Return Value Pointer Returns: Error Code

int OpenSOAPStringHashGetValue (  OpenSOAPStringHashPtr  strh, OpenSOAPStringPtr  key, void **  val )

Get value from OpenSOAPString Hash. Parameters: strh  OpenSOAPStringHashPtr [in] ((|strh|)) OpenSOAPString Hash key  OpenSOAPStringPtr [in] ((|key|)) Key Value val  void ** [out] ((|val|)) Returned Value Pointer Returns: Error Code

int OpenSOAPStringHashGetValueMB (  OpenSOAPStringHashPtr  strh, const char *  key, void **  val )

Get value from OpenSOAPString Hash. Parameters: strh  OpenSOAPStringHashPtr [in] ((|strh|)) OpenSOAPString Hash key  const char * [in] ((|key|)) Key Value val  void ** [out] ((|val|)) Returned Value Pointer Returns: Error Code

int OpenSOAPStringHashGetValues (  OpenSOAPStringHashPtr  strh, size_t *  sz, void **  vals )

Get OpenSOAPString Hash Values(ALL). Parameters: strh  OpenSOAPStringHashPtr [in] ((|strh|)) OpenSOAPString Hash sz  size_t * [in, out] ((|sz|)) vals  void ** [out] ((|vals|)) Returned value buffer. No relation to key order generated by OpenSOAPStringHashGetKeys(). Returns: Error Code

int OpenSOAPStringHashGetValueWC (  OpenSOAPStringHashPtr  strh, const wchar_t *  key, void **  val )

Get value from OpenSOAPString Hash. Parameters: strh  OpenSOAPStringHashPtr [in] ((|strh|)) OpenSOAPString Hash key  const wchar_t * [in] ((|key|)) Key Value val  void ** [out] ((|val|)) Returned Value Pointer Returns: Error Code

int OpenSOAPStringHashRelease (  OpenSOAPStringHashPtr  strh  )

Release OpenSOAPString Hash. Parameters: strh  OpenSOAPStringHashPtr [in] ((|strh|)) OpenSOAPString Hash Returns: Error Code

int OpenSOAPStringHashRemoveKey (  OpenSOAPStringHashPtr  strh, OpenSOAPStringPtr  key, void **  val )

Remove Key From OpenSOAPString Hash. Parameters: strh  OpenSOAPStringHashPtr [in, out] ((|strh|)) OpenSOAPString Hash key  OpenSOAPStringPtr [in] ((|key|)) Key Value val  void ** [out] ((|val|)) Location of registered value. If NULL, no value is returned. Returns: Error Code

int OpenSOAPStringHashSetValue (  OpenSOAPStringHashPtr  strh, OpenSOAPStringPtr  key, void *  val )

Register Value In OpenSOAPString Hash. Parameters: strh  OpenSOAPStringHashPtr [in, out] ((|strh|)) OpenSOAPString Hash key  OpenSOAPStringPtr [in] ((|key|)) Key Value val  void * [in] ((|val|)) Registered Value Returns: Error Code

int OpenSOAPStringHashSetValueMB (  OpenSOAPStringHashPtr  strh, const char *  key, void *  val )

Register Value In OpenSOAPString Hash. Parameters: strh  OpenSOAPStringHashPtr [in, out] ((|strh|)) OpenSOAPString Hash key  const char * [in] ((|key|)) Key Value val  void * [in] ((|val|)) Registered Value Returns: Error Code

int OpenSOAPStringHashSetValueWC (  OpenSOAPStringHashPtr  strh, const wchar_t *  key, void *  val )

Register Value In OpenSOAPString Hash. Parameters: strh  OpenSOAPStringHashPtr [in, out] ((|strh|)) OpenSOAPString Hash key  const wchar_t * [in] ((|key|)) Key Value val  void * [in] ((|val|)) Registered Value Returns: Error Code

---