The SEDRIS Data Representation Model
APPENDIX D - Functions SE FreeString |
---|
extern SE_DRM_Status_Code | |||
SE_FreeString | |||
( | |||
SE_String | * | to_free, | 1 |
void | (*dealloc_func_in_ptr)(void *) | 2 | |
); |
Frees any internal pointers in the data in the given SE_String structure.
IMPORTANT NOTE: | This function is intended only for use with SE_CloneString(), if dealloc_func_in_ptr is not specified. |
---|
SE_DRM_STAT_CODE_SUCCESS | and internal pointers within the data of *to_free are freed and set to NULL, and any corresponding "array size" fields are set to zero (0), if valid parameters were passed in. |
SE_DRM_STAT_CODE_NULL_REQUIRED_PARAMETER | and *to_free is left unchanged, if to_free is NULL. |
1 pointer to the SE_String whose internal pointer(s) (if in use) are to be freed.
2 pointer to a user-supplied function to be used to free the memory. Must correspond to the function used to allocate the memory. (Should be omitted if SE_CloneString() was used.)
Prev: SE_FreeSingleValue.
Next: SE_FreeTelephoneInformation.
Up:Index.
|