TutBufDestroy

Name

TutBufDestroy — destroy a buffer

Synopsis

T_BOOL TutBufDestroy(buf) 
T_BUF buf; 

Arguments

buf — the buffer to destroy

Return Values

TRUE if successful, FALSE otherwise.

Diagnostics

None

Description

TutBufDestroy destroys a buffer. If the buffer is not static, because it was created with TutBufCreate, then the buffer object and all of the data contained by that object is destroyed. If the buffer is static, because it was created with TutBufCreateStatic, then only the buffer object itself is destroyed, not the data.

Caution

None

See Also

TutBufCreate, TutBufCreateStatic

Examples

This example destroys a buffer:

T_BOOL status; 
status = TutBufDestroy(buf); 
if (status == FALSE) { 
  /* error */ 
}