.\" Process this file with .\" groff -man -Tascii cryptday.1 .\" .TH js_destroy 3 "August 2000" JS "js library reference" .\" We don't want hyphenation (it's too ugly) .\" We also disable justification when using nroff .hy 0 .if n .na .SH NAME js_destroy \- destroy a js_string object .SH SYNOPSIS .nf .B #include "JsStr.h" .sp .B "int js_destroy(js_string *object);" .fi .SH DESCRIPTION .B js_destroy destroys an existing .B js_string object, freeing any memory the .B js_string object allocated. .SH ARGUMENTS .B object is a pointer to the .B js_string object you wish to destroy. .SH "RETURN VALUE" .B js_destroy returns .I JS_SUCCESS if it was able to destroy the .B js_string object in question. If it is unable to destroy .B js_string object, this function will return the value .I JS_ERROR. The most common reason for not being able to destory an object is because the object is not a legitimate .B js_string object. .SH EXAMPLE The following example creates then destroys a .B js_string object. .nf js_string *foo; foo = js_create(256,1); js_destroy(foo); .fi .SH AUTHOR Sam Trenholme <kiwi-zttfryb@koala.samiam.org>