EDCS FreeString

EDCS Reference Manual Functions EDCS FreeString

extern EDCS_Status_Code
EDCS_FreeString
(
EDCS_String	*	to_free,	(notes)
void	(dealloc_func_in_ptr)(void )	(notes)
);

Definition

Frees any internal pointers in the data in the given EDCS_String structure.

IMPORTANT NOTE: This function is intended only for use with EDCS_CloneString(), if dealloc_func_in_ptr is not specified.

IMPORTANT NOTE:	This function is intended only for use with EDCS_CloneString(), if dealloc_func_in_ptr is not specified.

Returns

EDCS_SC_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.

EDCS_SC_NULL_REQUIRED_PARAMETER and *to_free is left unchanged, if to_free is NULL.

Parameters Notes

to_free

 pointer to the EDCS_String whose internal pointer(s)
    (if in use) are to be freed.

dealloc_func_in_ptr

 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 EDCS_CloneString() was
    used.)

EDCS_SC_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.
EDCS_SC_NULL_REQUIRED_PARAMETER	and *to_free is left unchanged, if to_free is NULL.