Function CDM_JoinSetElements
|
|
Definition: | #include <CDM.h> |
---|
|
Prototype: | CDM_ByteSequence CDM_JoinSetElements(CDM_Set Set, const char *joinString);
|
---|
Arguments: | Set: The set whose elements will be joined. (CDM_Set) joinString: A NULL-terminated string to be used as a delimiter among elements. (const char *)
|
---|
|
|
Description:
This function will create and return a newly created object (of type
CDM_ByteSequence or CDM_RawData) whose string will be the
junction of all the set elements. Note that the returned object is not owned by the CDM. The caller is
responsible to use CDM_Free (or Tcl_Free) in order to free the string and
the memory associated with it.
Return Value:
A newly created text object (of type CDM_ByteSequence or CDM_RawData)
containing the merged string. CDM does not own the
returned object: the caller is responsible to use CDM_Free (or
Tcl_Free) in order to free the object when it is not needed any more.
In case of an error NULL will be returned and an error message will be
left at the current active Tcl interpreter (CDM_Interp).
Notes:
This function is equivalent to the "join" Tcl command.
See Also:
CDM_Free, Tcl_Free
Generated by: petasis@aias on Wed Aug 16 10:31:57 PM EEST 2006.