TutBufRewind

Name

TutBufRewind — rewind the current position in the buffer

Synopsis

T_BOOL TutBufRewind(buf, ptr) 
T_BUF buf; 
T_PTR ptr; 

Arguments

buf — T_BUF object to rewind

ptr — new position

Return Values

TRUE if successful, FALSE otherwise.

Diagnostics

None

Description

TutBufRewind moves the current position to the location given by ptr. If ptr is NULL, then the current position is set to the beginning. This function fails if ptr is outside the bounds of the buffer.

Caution

None

See Also

TutBufReset

Examples

This example rewinds a buffer to the beginning:

T_BOOL status; 
status = TutBufRewind(buf, NULL); 
if (status == FALSE) { 
  /* error */ 
}