| Types and objects | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Defined in header <stdio.h> | ||
int ungetc(int ch,FILE* stream); | ||
Ifch does not equalEOF, pushes the characterch (reinterpreted asunsignedchar) into the input buffer associated with the streamstream in such a manner that subsequent read operation fromstream will retrieve that character. The external device associated with the stream is not modified.
Stream repositioning operationsfseek,fsetpos, andrewind discard the effects ofungetc.
Ifungetc is called more than once without an intervening read or repositioning, it may fail (in other words, a pushback buffer of size 1 is guaranteed, but any larger buffer is implementation-defined). If multiple successfulungetc were performed, read operations retrieve the pushed-back characters in reverse order ofungetc.
Ifch equalsEOF, the operation fails and the stream is not affected.
A successful call toungetc clears the end of file status flagfeof.
A successful call toungetc on a binary stream decrements the stream position indicator by one (the behavior is indeterminate if the stream position indicator was zero).
A successful call toungetc on a text stream modifies the stream position indicator in unspecified manner but guarantees that after all pushed-back characters are retrieved with a read operation, the stream position indicator is equal to its value beforeungetc.
Contents |
| ch | - | character to be pushed into the input stream buffer |
| stream | - | file stream to put the character back to |
On successch is returned.
On failureEOF is returned and the given stream remains unchanged.
The size of the pushback buffer varies in practice from 4k (Linux, MacOS) to as little as 4 (Solaris) or the guaranteed minimum 1 (HPUX, AIX).
The apparent size of the pushback buffer may be larger if the character that is pushed back equals the character existing at that location in the external character sequence (the implementation may simply decrement the read file position indicator and avoid maintaining a pushback buffer).
Demonstrates the original purpose ofungetc: implementation ofscanf
#include <ctype.h>#include <stdio.h> void demo_scanf(constchar* fmt,FILE* s){while(*fmt!='\0'){if(*fmt=='%'){int c;switch(*++fmt){case'u':while(isspace(c=getc(s))){}unsignedint num=0;while(isdigit(c)){ num= num*10+ c-'0'; c=getc(s);}printf("%%u scanned %u\n", num); ungetc(c, s);break;case'c': c=getc(s);printf("%%c scanned '%c'\n", c);break;}}else++fmt;}} int main(void){FILE* f=fopen("input.txt","w+");if(f!=NULL){fputs("123x", f);rewind(f); demo_scanf("%u%c", f);fclose(f);}return0;}
Output:
%u scanned 123%c scanned 'x'
| gets a character from a file stream (function)[edit] | |
C++ documentation forungetc | |
