The SEDRIS Data Representation Model
APPENDIX D - Functions
SE FreeFields
extern SE_DRM_Status_Code
SE_FreeFields
(
SE_Fields *to_free, (notes)
void (*dealloc_func_in_ptr)(void *) (notes)
);

Definition

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

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


Returns

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.

Parameters Notes


to_free

 the fields whose internal pointers 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 SE_CloneFields() was used.)

Prev: SE_FreeDataQualityElement. Next: SE_FreeOnlineResource. Up:Index.

Last updated: July 16, 2004 Copyright © 2004 SEDRIS™