Main Page | File List | File Members

String.h File Reference

OpenSOAP API String Processing. More...

#include <OpenSOAP/ByteArray.h>
#include <stdarg.h>

Go to the source code of this file.

Typedefs

typedef tagOpenSOAPString OpenSOAPString
 OpenSOAPString Structure Type Definition.

typedef OpenSOAPString * OpenSOAPStringPtr
 OpenSOAPString Pointer Type Definition.

typedef int(* OpenSOAPStringFindIfFunc )(void *opt, wchar_t c, int *judge)
 Find String Function Pointer Type Definition.


Functions

int OpenSOAPStringCreate (OpenSOAPStringPtr *str)
 Create 0 length OpenSOAP Character String.

int OpenSOAPStringCreateWithMB (const char *mb_str, OpenSOAPStringPtr *str)
 Create OpenSOAP Character String Initialized With a MultiByte String.

int OpenSOAPStringCreateWithWC (const wchar_t *wc_str, OpenSOAPStringPtr *str)
 Create OpenSOAP Character String Initialized With a WideCharacter String.

int OpenSOAPStringCreateWithCharEncodingString (const char *char_enc, OpenSOAPByteArrayPtr char_enc_str, OpenSOAPStringPtr *str)
 Create OpenSOAP Character String Initialized With a Character-encoding Specified String.

int OpenSOAPStringCreateWithUTF8 (const char *utf8Str, OpenSOAPStringPtr *str)
 Create OpenSOAP Character String Initialized With a UTF-8 Encoded String.

int OpenSOAPStringRetain (OpenSOAPStringPtr str)
 Add a Reference to a Resource.

int OpenSOAPStringRelease (OpenSOAPStringPtr str)
 Remove a Reference. If the number of references is zero, release the resource.

int OpenSOAPStringGetLengthMB (OpenSOAPStringPtr str, size_t *len)
 Get length of MultiByte Stringv for the current locale.

int OpenSOAPStringGetLengthWC (OpenSOAPStringPtr str, size_t *len)
 Get length of WideCharacter String.

int OpenSOAPStringGetStringMBWithAllocator (OpenSOAPStringPtr str, char *(*memAllocator)(size_t), size_t *len, char **mbStr)
 OpenSOAP String GetStringMB with memAllocator.

int OpenSOAPStringGetStringWCWithAllocator (OpenSOAPStringPtr str, wchar_t *(*memAllocator)(size_t), size_t *len, wchar_t **wcStr)
 OpenSOAP String GetStringWC with memAllocator.

int OpenSOAPStringGetStringUTF8WithAllocator (OpenSOAPStringPtr str, char *(*memAllocator)(size_t), size_t *len, char **utf8Str)
 OpenSOAP String GetString as UTF-8 encoding with memAllocator.

int OpenSOAPStringGetStringMB (OpenSOAPStringPtr str, size_t *len, char *mb_Str)
 Get MultiByte String.

int OpenSOAPStringGetStringWC (OpenSOAPStringPtr str, size_t *len, wchar_t *wc_str)
 Get WideCharacter String.

int OpenSOAPStringGetCharEncodingString (OpenSOAPStringPtr str, const char *char_enc, OpenSOAPByteArrayPtr char_enc_str)
 Get character encoding string.

int OpenSOAPStringSetStringMB (OpenSOAPStringPtr str, const char *mb_str)
 Set MultiByte Character string for the current locale.

int OpenSOAPStringSetStringWC (OpenSOAPStringPtr str, const wchar_t *wc_str)
 Set WideCharacter string.

int OpenSOAPStringSetCharEncodingString (OpenSOAPStringPtr str, const char *char_enc, OpenSOAPByteArrayPtr charEncStr)
 Set character encoding string for the current locale.

int OpenSOAPStringSetStringUTF8 (OpenSOAPStringPtr str, const char *utf8Str)
 Set UTF-8 encoded string.

int OpenSOAPStringFormatMB (OpenSOAPStringPtr str, const char *format,...)
 Format MultiByte String.

int OpenSOAPStringFormatWC (OpenSOAPStringPtr str, const wchar_t *format,...)
 Format WideCharacter String.

int OpenSOAPStringVFormatMB (OpenSOAPStringPtr str, const char *format, va_list ap)
 Format MultiByte String with va_list.

int OpenSOAPStringVFormatWC (OpenSOAPStringPtr str, const wchar_t *format, va_list ap)
 Format WideCharacter String with va_list.

int OpenSOAPStringCompareMB (OpenSOAPStringPtr str, const char *cmp_str, int *cmp_rslt)
 Compare MultiByte String.

int OpenSOAPStringCompareWC (OpenSOAPStringPtr str, const wchar_t *cmp_str, int *cmp_rslt)
 Compare WideCharacter String.

int OpenSOAPStringCompare (OpenSOAPStringPtr str, OpenSOAPStringPtr cmp_str, int *cmp_rslt)
 Compare String.

int OpenSOAPStringFindStringMB (OpenSOAPStringPtr str, const char *find_str, size_t *idx)
 Find String.

int OpenSOAPStringFindStringWC (OpenSOAPStringPtr str, const wchar_t *find_str, size_t *idx)
 Find String.

int OpenSOAPStringFindString (OpenSOAPStringPtr str, OpenSOAPStringPtr find_str, size_t *idx)
 Find String.

int OpenSOAPStringFindIfStringIndex (OpenSOAPStringPtr str, OpenSOAPStringFindIfFunc find_func, void *find_func_opt, size_t *idx)
 Find String.

int OpenSOAPStringReplaceStringMB (OpenSOAPStringPtr str, const char *find_str, const char *rplc_str, size_t *idx)
 Replace String.

int OpenSOAPStringReplaceStringWC (OpenSOAPStringPtr str, const wchar_t *find_str, const wchar_t *rplc_str, size_t *idx)
 Replace String.

int OpenSOAPStringReplaceString (OpenSOAPStringPtr str, OpenSOAPStringPtr find_str, OpenSOAPStringPtr rplc_str, size_t *idx)
 Replace String.

int OpenSOAPStringClear (OpenSOAPStringPtr str)
 Clear OpenSOAPString, set length to 0.

int OpenSOAPStringAppendMB (OpenSOAPStringPtr str, const char *mb_str, size_t mb_len)
 Concatenate MB String To OpenSOAPString for current locale.

int OpenSOAPStringAppendWC (OpenSOAPStringPtr str, const wchar_t *wc_str, size_t wc_len)
 Concatenate WC String To OpenSOAPString.

int OpenSOAPStringDuplicate (OpenSOAPStringPtr str, OpenSOAPStringPtr *dup_str)
 Duplicate String.

int OpenSOAPStringGetSubstring (OpenSOAPStringPtr str, size_t beg, size_t len, OpenSOAPStringPtr *sub_str)
 Duplicate String.

int OpenSOAPStringConvertCharEncoding (const char *from_enc, OpenSOAPByteArrayPtr from_str, const char *to_enc, OpenSOAPByteArrayPtr to_str)
 Convert character encoding. This function does not use the OpenSOAP member, but is used for string processing.

int OpenSOAPStringConvertXMLCharRefToUTF8 (const unsigned char *utf8Beg, OpenSOAPByteArrayPtr utf8BAry)
 Convert XML's CharRef to UTF-8 encoding. This function does not use the OpenSOAP member, but is used for string processing.

int OpenSOAPStringGetStringUSASCII (OpenSOAPStringPtr str, OpenSOAPByteArrayPtr charEncStr)
 Get US-ASCII string.

int OpenSOAPStringIterateProc (OpenSOAPStringPtr str, int(*iterateProc)(unsigned long c, size_t idx, size_t len, void *opt), int(*beforeProc)(size_t len, void *opt), int(*afterProc)(size_t len, void *opt), void *opt)
 Iterate procedure.

Detailed Description

OpenSOAP API String Processing.

Author:
OpenSOAP Development Team

Typedef Documentation

int(* OpenSOAPStringFindIfFunc)(void *opt, wchar_t c, int *judge)
 

Find String Function Pointer Type Definition.

Parameters:
opt void * [in] Find Function Option
c wchar_t [in]
judge int * [out] Result
Returns:
Error Code

Function Documentation

int OpenSOAPStringAppendMB (  OpenSOAPStringPtr  str,
const char *  mb_str,
size_t  mb_len
) 
 

Concatenate MB String To OpenSOAPString for current locale.

Parameters:
str OpenSOAPStringPtr [in] ((|str|)) OpenSOAP String
mb_str char * [in] ((|mb_str|)) Concatenate string
mb_len size_t [in] ((|mb_len|)) Concatenate string number of characters. If 0, concatenate the entire mb_str.
Returns:
Error Code

int OpenSOAPStringAppendWC (  OpenSOAPStringPtr  str,
const wchar_t *  wc_str,
size_t  wc_len
) 
 

Concatenate WC String To OpenSOAPString.

Parameters:
str OpenSOAPStringPtr [in] ((|str|)) OpenSOAP String
wc_str wchar_t * [in] ((|wc_str|)) Concatenate string
wc_len size_t [in] ((|wc_len|)) Concatenate string number of characters. If 0, concatenate the entire wc_str.
Returns:
Error Code

int OpenSOAPStringClear (  OpenSOAPStringPtr  str  ) 
 

Clear OpenSOAPString, set length to 0.

Parameters:
str OpenSOAPStringPtr [in] ((|str|)) OpenSOAP String
Returns:
Error Code

int OpenSOAPStringCompare (  OpenSOAPStringPtr  str,
OpenSOAPStringPtr  cmp_str,
int *  cmp_rslt
) 
 

Compare String.

Parameters:
str OpenSOAPStringPtr [in] ((|str|)) OpenSOAP String
cmp_str OpenSOAPStringPtr [in] ((|cmp_str|)) Character String
cmp_rslt int * [out] ((|cmp_rslt|)) Comparison Result. Same as for strcmp().
Returns:
Error Code

int OpenSOAPStringCompareMB (  OpenSOAPStringPtr  str,
const char *  cmp_str,
int *  cmp_rslt
) 
 

Compare MultiByte String.

Parameters:
str OpenSOAPStringPtr [in] ((|str|)) OpenSOAP String
cmp_str const char * [in] ((|cmp_str|)) Character String
cmp_rslt int * [out] ((|cmp_rslt|)) Comparison Result. Same as for strcmp().
Returns:
Error Code

int OpenSOAPStringCompareWC (  OpenSOAPStringPtr  str,
const wchar_t *  cmp_str,
int *  cmp_rslt
) 
 

Compare WideCharacter String.

Parameters:
str OpenSOAPStringPtr [in] ((|str|)) OpenSOAP String
cmp_str const wchar_t * [in] ((|cmp_str|)) Character String
cmp_rslt int * [out] ((|cmp_rslt|)) Comparison Result. Same as for strcmp().
Returns:
Error Code

int OpenSOAPStringConvertCharEncoding (  const char *  from_enc,
OpenSOAPByteArrayPtr  from_str,
const char *  to_enc,
OpenSOAPByteArrayPtr  to_str
) 
 

Convert character encoding. This function does not use the OpenSOAP member, but is used for string processing.

Parameters:
from_enc const char * [in] ((|fromEnc|)) Convert source character encoding. If NULL or "" then current locale encoding.
from_str OpenSOAPByteArrayPtr [in] ((|fromStr|)) Convert source string data.
to_enc const char * [in] ((|toEnc|)) Convert destination character encoding. If NULL or "" then current locale encoding.
to_str OpenSOAPByteArrayPtr [out] ((|toStr|)) Convert destination string data. If fromEnc equal to toEnc, then copy fromStr to toStr.
Returns:
Error Code

int OpenSOAPStringConvertXMLCharRefToUTF8 (  const unsigned char *  utf8Beg,
OpenSOAPByteArrayPtr  utf8BAry
) 
 

Convert XML's CharRef to UTF-8 encoding. This function does not use the OpenSOAP member, but is used for string processing.

Parameters:
utf8Beg const unsigned char * [in] ((|utf8Beg|)) Convert source UTF-8 encode string data begin pointer.
utf8BAry OpenSOAPByteArrayPtr [out] ((|toStr|)) Convert destination string data.
Returns:
Error Code

int OpenSOAPStringCreate (  OpenSOAPStringPtr *  str  ) 
 

Create 0 length OpenSOAP Character String.

Parameters:
str OpenSOAPStringPtr * [out] ((|str|)) OpenSOAP String
Returns:
Error Code

int OpenSOAPStringCreateWithCharEncodingString (  const char *  char_enc,
OpenSOAPByteArrayPtr  char_enc_str,
OpenSOAPStringPtr *  str
) 
 

Create OpenSOAP Character String Initialized With a Character-encoding Specified String.

Parameters:
char_enc const char * [in] ((|char_enc|)) Character Encoding
char_enc_str OpenSOAPByteArrayPtr [in] ((|char_enc_str|)) Character String
str OpenSOAPStringPtr * [out] ((|str|)) Created OpenSOAP Character String
Returns:
Error Code

int OpenSOAPStringCreateWithMB (  const char *  mb_str,
OpenSOAPStringPtr *  str
) 
 

Create OpenSOAP Character String Initialized With a MultiByte String.

Parameters:
mb_str const char * [in] ((|mb_str|)) MultiByte Character String
str OpenSOAPStringPtr * [out] ((|str|)) Created OpenSOAP Character String
Returns:
Error Code

int OpenSOAPStringCreateWithUTF8 (  const char *  utf8Str,
OpenSOAPStringPtr *  str
) 
 

Create OpenSOAP Character String Initialized With a UTF-8 Encoded String.

Parameters:
utf8Str const char * [in] ((|utf8Str|)) UTF-8 encoded string
str OpenSOAPStringPtr * [out] ((|str|)) Created OpenSOAP Character String
Returns:
Error Code

int OpenSOAPStringCreateWithWC (  const wchar_t *  wc_str,
OpenSOAPStringPtr *  str
) 
 

Create OpenSOAP Character String Initialized With a WideCharacter String.

Parameters:
wc_str const wchar_t * [in] ((|wc_str|)) Wide Character String
str OpenSOAPStringPtr * [out] ((|str|)) Created OpenSOAP Character String
Returns:
Error Code

int OpenSOAPStringDuplicate (  OpenSOAPStringPtr  str,
OpenSOAPStringPtr *  dup_str
) 
 

Duplicate String.

Parameters:
str OpenSOAPStringPtr [in] ((|str|)) OpenSOAP String
dup_str OpenSOAPStringPtr * [out] ((|dup_str|)) Duplicate string
Returns:
Error Code

int OpenSOAPStringFindIfStringIndex (  OpenSOAPStringPtr  str,
OpenSOAPStringFindIfFunc  find_func,
void *  find_func_opt,
size_t *  idx
) 
 

Find String.

Parameters:
str OpenSOAPStringPtr [in] ((|str|)) OpenSOAP String
find_func OpenSOAPStringFindIfFunc [in] ((|find_func|)) Search condition function
find_func_opt void * [in] ((|find_func_opt|)) Search condition function first parameter
idx size_t * [in, out] ((|idx|)) [in]:Search start index; [out]:Search result index.
Returns:
Error Code

int OpenSOAPStringFindString (  OpenSOAPStringPtr  str,
OpenSOAPStringPtr  find_str,
size_t *  idx
) 
 

Find String.

Parameters:
str OpenSOAPStringPtr [in] ((|str|)) OpenSOAP String
find_str OpenSOAPStringPtr [in] ((|find_str|)) Search string
idx size_t * [in, out] ((|idx|)) [in]:Search start index; [out]:Search result index.
Returns:
Error Code

int OpenSOAPStringFindStringMB (  OpenSOAPStringPtr  str,
const char *  find_str,
size_t *  idx
) 
 

Find String.

Parameters:
str OpenSOAPStringPtr [in] ((|str|)) OpenSOAP String
find_str const char * [in] ((|find_str|)) Search string
idx size_t * [in, out] ((|idx|)) [in]:Search start index; [out]:Search result index.
Returns:
Error Code

int OpenSOAPStringFindStringWC (  OpenSOAPStringPtr  str,
const wchar_t *  find_str,
size_t *  idx
) 
 

Find String.

Parameters:
str OpenSOAPStringPtr [in] ((|str|)) OpenSOAP String
find_str const wchar_t * [in] ((|find_str|)) Search string
idx size_t * [in, out] ((|idx|)) [in]:Search start index; [out]:Search result index.
Returns:
Error Code

int OpenSOAPStringFormatMB (  OpenSOAPStringPtr  str,
const char *  format,
  ...
) 
 

Format MultiByte String.

Parameters:
str OpenSOAPStringPtr [in] ((|str|)) OpenSOAP String
format const char * [in] ((|format|)) Format String
... Variable parameters
Returns:
Error Code

int OpenSOAPStringFormatWC (  OpenSOAPStringPtr  str,
const wchar_t *  format,
  ...
) 
 

Format WideCharacter String.

Parameters:
str OpenSOAPStringPtr [in] ((|str|)) OpenSOAP String
format const wchar_t * [in] ((|format|)) Format String
... Variable parameters
Returns:
Error Code

int OpenSOAPStringGetCharEncodingString (  OpenSOAPStringPtr  str,
const char *  char_enc,
OpenSOAPByteArrayPtr  char_enc_str
) 
 

Get character encoding string.

Parameters:
str OpenSOAPStringPtr [in] ((|str|)) OpenSOAP String
char_enc const char * [in] ((|charEnc|)) character encoding
char_enc_str OpenSOAPByteArrayPtr [out] ((|charEncStr|)) Character String
Returns:
Error Code

int OpenSOAPStringGetLengthMB (  OpenSOAPStringPtr  str,
size_t *  len
) 
 

Get length of MultiByte Stringv for the current locale.

Parameters:
str OpenSOAPStringPtr [in] ((|str|)) OpenSOAP Character String
len size_t * [out] ((|len|)) length
Returns:
Error Code

int OpenSOAPStringGetLengthWC (  OpenSOAPStringPtr  str,
size_t *  len
) 
 

Get length of WideCharacter String.

Parameters:
str OpenSOAPStringPtr [in] ((|str|)) OpenSOAP Character String
len size_t * [out] ((|len|)) length
Returns:
Error Code

int OpenSOAPStringGetStringMB (  OpenSOAPStringPtr  str,
size_t *  len,
char *  mb_Str
) 
 

Get MultiByte String.

Parameters:
str OpenSOAPStringPtr [in] ((|str|)) OpenSOAP String
len size_t * [in, out] ((|len|)) size.
mb_Str char * [out] ((|mb_str|)) Character String
Returns:
Error Code

int OpenSOAPStringGetStringMBWithAllocator (  OpenSOAPStringPtr  str,
char *(*  memAllocator)(size_t),
size_t *  len,
char **  mbStr
) 
 

OpenSOAP String GetStringMB with memAllocator.

Parameters:
str OpenSOAPStringPtr [in] ((|str|)) OpenSOAP Character String
memAllocator() char * [in] ( * ((|memAllocator|)) )(size_t) memAllocator function pointer. If NULL, memAllocator acts like (char *)malloc(size).
len size_t * [out] ((|len|)) length return buffer pointer. If NULL, no effect.
mbStr char ** [out] ((|mbStr|)) MB string return buffer pointer. If NULL, then error.
Note:
After calling this function, the memory allocated to *mbStr should be released.
Returns:
Error Code

int OpenSOAPStringGetStringUSASCII (  OpenSOAPStringPtr  str,
OpenSOAPByteArrayPtr  charEncStr
) 
 

Get US-ASCII string.

Parameters:
str OpenSOAPStringPtr [in] ((|str|)) OpenSOAP String
charEncStr OpenSOAPByteArrayPtr [out] ((|charEncStr|)) output buffer
Returns:
Error Code

int OpenSOAPStringGetStringUTF8WithAllocator (  OpenSOAPStringPtr  str,
char *(*  memAllocator)(size_t),
size_t *  len,
char **  utf8Str
) 
 

OpenSOAP String GetString as UTF-8 encoding with memAllocator.

Parameters:
str OpenSOAPStringPtr [in] ((|str|)) OpenSOAP Character String
memAllocator() char * [in] ( * ((|memAllocator|)) )(size_t) memAllocator function pointer. If NULL, memAllocator acts like (char *)malloc(size).
len size_t * [out] ((|len|)) length return buffer pointer. If NULL, no effect.
utf8Str char ** [out] ((|utf8Str|)) UTF8 string return buffer pointer. If NULL, then error.
Note:
After calling this function, the memory allocated to *utf8Str should be released.
Returns:
Error Code

int OpenSOAPStringGetStringWC (  OpenSOAPStringPtr  str,
size_t *  len,
wchar_t *  wc_str
) 
 

Get WideCharacter String.

Parameters:
str OpenSOAPStringPtr [in] ((|str|)) OpenSOAP String
len size_t * [in, out] ((|len|)) size.
wc_str char * [out] ((|wc_str|)) Character String
Returns:
Error Code

int OpenSOAPStringGetStringWCWithAllocator (  OpenSOAPStringPtr  str,
wchar_t *(*  memAllocator)(size_t),
size_t *  len,
wchar_t **  wcStr
) 
 

OpenSOAP String GetStringWC with memAllocator.

Parameters:
str OpenSOAPStringPtr [in] ((|str|)) OpenSOAP Character String
memAllocator() wchar_t * [in] ( * ((|memAllocator|)) )(size_t) memAllocator function pointer. If NULL, memAllocator acts like (char *)malloc(size).
len size_t * [out] ((|len|)) length return buffer pointer. If NULL, no effect.
wcStr wchar_t ** [out] ((|wcStr|)) WC string return buffer pointer. If NULL, then error.
Note:
After calling this function, the memory allocated to *wcStr should be released.
Returns:
Error Code

int OpenSOAPStringGetSubstring (  OpenSOAPStringPtr  str,
size_t  beg,
size_t  len,
OpenSOAPStringPtr *  sub_str
) 
 

Duplicate String.

Parameters:
str OpenSOAPStringPtr [in] ((|str|)) OpenSOAP String
beg size_t [in] ((|beg|)) Substring start index
len size_t [in] ((|len|)) Substring length. If len == -1 then copy to end of string.
sub_str OpenSOAPStringPtr * [out] ((|sub_str|)) Substring
Returns:
Error Code

int OpenSOAPStringIterateProc (  OpenSOAPStringPtr  str,
int(*  iterateProc)(unsigned long c, size_t idx, size_t len, void *opt),
int(*  beforeProc)(size_t len, void *opt),
int(*  afterProc)(size_t len, void *opt),
void *  opt
) 
 

Iterate procedure.

Parameters:
str OpenSOAPStringPtr [in] ((|str|)) OpenSOAP String
iterateProc() int [in] ( * ((|iterateProc|)) )(unsigned long, size_t, size_t, void *) iterate procedure
beforeProc() int [in] ( * ((|beforeProc|)) )(size_t, void *) Before iterate procedure. If NULL, then no effect
afterProc() int [in] ( * ((|afterProc|)) )(size_t, void *) After iterate procedure. If NULL, then no effect
opt void * [in, out] ((|opt|)) iterateProc, beforeProc, and afterProc's option parameters.
Returns:
Error Code

int OpenSOAPStringRelease (  OpenSOAPStringPtr  str  ) 
 

Remove a Reference. If the number of references is zero, release the resource.

Parameters:
str OpenSOAPStringPtr [in] ((|str|)) OpenSOAP Character String
Returns:
Error Code

int OpenSOAPStringReplaceString (  OpenSOAPStringPtr  str,
OpenSOAPStringPtr  find_str,
OpenSOAPStringPtr  rplc_str,
size_t *  idx
) 
 

Replace String.

Parameters:
str OpenSOAPStringPtr [in, out] ((|str|)) OpenSOAP String
find_str OpenSOAPStringPtr [in] ((|find_str|)) Search string
rplc_str OpenSOAPStringPtr [in] ((|rplc_str|)) Replacement string
idx size_t * [in, out] ((|idx|)) [in]:Search start index; [out]:Replacement start index. If can't replace, set (size_)(-1).
Returns:
Error Code

int OpenSOAPStringReplaceStringMB (  OpenSOAPStringPtr  str,
const char *  find_str,
const char *  rplc_str,
size_t *  idx
) 
 

Replace String.

Parameters:
str OpenSOAPStringPtr [in, out] ((|str|)) OpenSOAP String
find_str const char * [in] ((|find_str|)) Search string
rplc_str const char * [in] ((|rplc_str|)) Replacement string
idx size_t * [in, out] ((|idx|)) [in]:Search start index; [out]:Replacement start index. If can't replace, set (size_)(-1).
Returns:
Error Code

int OpenSOAPStringReplaceStringWC (  OpenSOAPStringPtr  str,
const wchar_t *  find_str,
const wchar_t *  rplc_str,
size_t *  idx
) 
 

Replace String.

Parameters:
str OpenSOAPStringPtr [in, out] ((|str|)) OpenSOAP String
find_str const wchar_t * [in] ((|find_str|)) Search string
rplc_str const wchar_t * [in] ((|rplc_str|)) Replacement string
idx size_t * [in, out] ((|idx|)) [in]:Search start index; [out]:Replacement start index. If can't replace, set (size_)(-1).
Returns:
Error Code

int OpenSOAPStringRetain (  OpenSOAPStringPtr  str  ) 
 

Add a Reference to a Resource.

Parameters:
str OpenSOAPStringPtr [in] ((|str|)) OpenSOAP Character String
Returns:
Error Code

int OpenSOAPStringSetCharEncodingString (  OpenSOAPStringPtr  str,
const char *  char_enc,
OpenSOAPByteArrayPtr  charEncStr
) 
 

Set character encoding string for the current locale.

Parameters:
str OpenSOAPStringPtr [in, out] ((|str|)) OpenSOAP String
char_enc const char * [in] ((|charEnc|)) Character encoding
charEncStr OpenSOAPByteArrayPtr [in] ((|charEncStr|)) Character String
Returns:
Error Code

int OpenSOAPStringSetStringMB (  OpenSOAPStringPtr  str,
const char *  mb_str
) 
 

Set MultiByte Character string for the current locale.

Parameters:
str OpenSOAPStringPtr [in, out] ((|str|)) OpenSOAP String
mb_str char * [in] ((|mb_str|)) Character String
Returns:
Error Code

int OpenSOAPStringSetStringUTF8 (  OpenSOAPStringPtr  str,
const char *  utf8Str
) 
 

Set UTF-8 encoded string.

Parameters:
str OpenSOAPStringPtr [out] ((|str|))
utf8Str const char * [in] ((|utf8Str|))
Returns:
Error Code

int OpenSOAPStringSetStringWC (  OpenSOAPStringPtr  str,
const wchar_t *  wc_str
) 
 

Set WideCharacter string.

Parameters:
str OpenSOAPStringPtr [in, out] ((|str|)) OpenSOAP String
wc_str const wchar_t * [in] ((|wc_str|)) Character String
Returns:
Error Code

int OpenSOAPStringVFormatMB (  OpenSOAPStringPtr  str,
const char *  format,
va_list  ap
) 
 

Format MultiByte String with va_list.

Parameters:
str [out] OpenSOAP String
format [in] Format String
ap [in] Variable parameters
Returns:
Error Code

int OpenSOAPStringVFormatWC (  OpenSOAPStringPtr  str,
const wchar_t *  format,
va_list  ap
) 
 

Format WideCharacter String with va_list.

Parameters:
str [out] OpenSOAP String
format [in] Format String
ap [in] Variable parameters
Returns:
Error Code

Generated on Mon Oct 18 18:29:44 2004 for OpenSOAP by doxygen 1.3.6