/* -*-c-*-
*
- * $Id: dstr.c,v 1.4 1999/05/06 19:51:35 mdw Exp $
+ * $Id: dstr.c,v 1.5 1999/05/13 22:47:57 mdw Exp $
*
* Handle dynamically growing strings
*
/*----- Revision history --------------------------------------------------*
*
* $Log: dstr.c,v $
+ * Revision 1.5 1999/05/13 22:47:57 mdw
+ * Misc documentation fixes. Change `-ise' to `-ize' throughout.
+ *
* Revision 1.4 1999/05/06 19:51:35 mdw
* Reformatted the LGPL notice a little bit.
*
*
* Returns: ---
*
- * Use: Initialises a dynamic string.
+ * Use: Initializes a dynamic string.
*/
void dstr_create(dstr *d)
* @const char *p@ = pointer to @printf@-style format string
* @va_list ap@ = argument handle
*
- * Returns: ---
+ * Returns: The number of characters written to the string.
*
* Use: As for @dstr_putf@, but may be used as a back-end to user-
* supplied functions with @printf@-style interfaces.
* @const char *p@ = pointer to @printf@-style format string
* @...@ = argument handle
*
- * Returns: ---
+ * Returns: The number of characters written to the string.
*
* Use: Writes a piece of text to a dynamic string, doing @printf@-
* style substitutions as it goes. Intended to be robust if
* Use: Writes a dynamic string to a file.
*/
-size_t dstr_write(dstr *d, FILE *fp)
+size_t dstr_write(const dstr *d, FILE *fp)
{
return (fwrite(d->buf, 1, d->len, fp));
}
/* -*-c-*-
*
- * $Id: dstr.h,v 1.4 1999/05/06 19:51:35 mdw Exp $
+ * $Id: dstr.h,v 1.5 1999/05/13 22:47:57 mdw Exp $
*
* Handle dynamically growing strings
*
/*----- Revision history --------------------------------------------------*
*
* $Log: dstr.h,v $
+ * Revision 1.5 1999/05/13 22:47:57 mdw
+ * Misc documentation fixes. Change `-ise' to `-ize' throughout.
+ *
* Revision 1.4 1999/05/06 19:51:35 mdw
* Reformatted the LGPL notice a little bit.
*
*
* Returns: ---
*
- * Use: Initialises a dynamic string.
+ * Use: Initializes a dynamic string.
*/
extern void dstr_create(dstr */*d*/);
* @const char *p@ = pointer to @printf@-style format string
* @va_list ap@ = argument handle
*
- * Returns: ---
+ * Returns: The number of characters written to the string.
*
* Use: As for @dstr_putf@, but may be used as a back-end to user-
* supplied functions with @printf@-style interfaces.
* @const char *p@ = pointer to @printf@-style format string
* @...@ = argument handle
*
- * Returns: ---
+ * Returns: The number of characters written to the string.
*
* Use: Writes a piece of text to a dynamic string, doing @printf@-
* style substitutions as it goes. Intended to be robust if
* Use: Writes a dynamic string to a file.
*/
-extern size_t dstr_write(dstr */*d*/, FILE */*fp*/);
+extern size_t dstr_write(const dstr */*d*/, FILE */*fp*/);
/*----- That's all, folks -------------------------------------------------*/