prg_vector_destroy()
Abstract
Deallocates a vector and (optionally) performs a “deep destruction,” freeing all the elements that the vector contains.
Syntax
prg_vector_destroy (vector_ptr, dealloc_client_state)
| Argument | Type | Description |
|---|---|---|
vector_ptr |
PrgT_Vector * |
the vector to be destroyed |
dealloc_client_state |
int |
boolean specifying “deep destroy” when true |
Return Type
PrgT_Compcode
completion code indicating success or failure of the deallocation
Header
prg_vector.h
Details
Releases all memory used to manage the vector and the elements stored within it. Also, if dealloc_client_state is set to PRGC_TRUE, the vector's “destroy procedure” (which was provided when the vector was initially created) is called once for each of the elements in the vector (only if the procedure is non-NIL). The destroy procedure is responsible for any deeper-level deallocations within the elements, as necessary.