Search

18.7 — Random file I/O

The file pointer

Each file stream class contains a file pointer that is used to keep track of the current read/write position within the file. When something is read from or written to a file, the reading/writing happens at the file pointer’s current location. By default, when opening a file for reading or writing, the file pointer is set to the beginning of the file. However, if a file is opened in append mode, the file pointer is moved to the end of the file, so that writing does not overwrite any of the current contents of the file.

Random file access with seekg() and seekp()

So far, all of the file access we’ve done has been sequential -- that is, we’ve read or written the file contents in order. However, it is also possible to do random file access -- that is, skip around to various points in the file to read its contents. This can be useful when your file is full of records, and you wish to retrieve a specific record. Rather than reading all of the records until you get to the one you want, you can skip directly to the record you wish to retrieve.

Random file access is done by manipulating the file pointer using the seekg() function (for input) and seekp() function (for output). In case you are wondering, the g stands for “get” and the p for “put”.

The seekg() and seekp() functions take two parameters. The first parameter is an offset that determines how many bytes to move the file pointer. The second parameter is an Ios flag that specifies what the offset parameter should be offset from.

Ios seek flag Meaning
beg The offset is relative to the beginning of the file (default)
cur The offset is relative to the current location of the file pointer
end The offset is relative to the end of the file

A positive offset means move the file pointer towards the end of the file, whereas a negative offset means move the file pointer towards the beginning of the file.

Here are some examples:

Moving to the beginning or end of the file is easy:

Let’s do an example using seekg() and the input file we created in the last lesson. That input file looks like this:

This is line 1
This is line 2
This is line 3
This is line 4

Here is the example:

This produces the result:

is line 1
line 2
his is line 4

Note: Some compilers have buggy implementations of seekg() and tellg() when used in conjunction with text files (due to buffering). If your compiler is one of them (and you’ll know because your output will differ from the above), you can try opening the file in binary mode instead:

Two other useful functions are tellg() and tellp(), which return the absolute position of the file pointer. This can be used to determine the size of a file:

This prints:

64

which is how long sample.dat is in bytes (assuming a carriage return after the last line).

Reading and writing a file at the same time using fstream

The fstream class is capable of both reading and writing a file at the same time -- almost! The big caveat here is that it is not possible to switch between reading and writing arbitrarily. Once a read or write has taken place, the only way to switch between the two is to perform an operation that modifies the file position (e.g. a seek). If you don’t actually want to move the file pointer, you can always seek to the current position:

If you do not do this, any number of strange and bizarre things may occur.

(Note: Although it may seem that inf.seekg(0, ios::cur) would also work, it appears some compilers may optimize this away.)

One other bit of trickiness: Unlike ifstream, where we could say while (inf) to determine if there was more to read, this will not work with fstream.

Let’s do a file I/O example using fstream. We’re going to write a program that opens a file, reads its contents, and changes any vowels it finds to a ‘#’ symbol.

Other useful file functions

To delete a file, simply use the remove() function.

Also, the is_open() function will return true if the stream is currently open, and false otherwise.

A warning about writing pointers to disk

While streaming variables to a file is quite easy, things become more complicated when you’re dealing with pointers. Remember that a pointer simply holds the address of the variable it is pointing to. Although it is possible to read and write addresses to disk, it is extremely dangerous to do so. This is because a variable’s address may differ from execution to execution. Consequently, although a variable may have lived at address 0x0012FF7C when you wrote that address to disk, it may not live there any more when you read that address back in!

For example, let’s say you had an integer named nValue that lived at address 0x0012FF7C. You assigned nValue the value 5. You also declared a pointer named *pnValue that points to nValue. pnValue holds nValue’s address of 0x0012FF7C. You want to save these for later, so you write the value 5 and the address 0x0012FF7C to disk.

A few weeks later, you run the program again and read these values back from disk. You read the value 5 into another variable named nValue, which lives at 0x0012FF78. You read the address 0x0012FF7C into a new pointer named *pnValue. Because pnValue now points to 0x0012FF7C when the nValue lives at 0x0012FF78, pnValue is no longer pointing to nValue, and trying to access pnValue will lead you into trouble.

Rule: Do not write addresses to files. The variables that were originally at those addresses may be at different addresses when you read their values back in from disk, and the addresses will be invalid.

A.1 -- Static and dynamic libraries
Index
18.6 -- Basic file I/O

29 comments to 18.7 — Random file I/O

  • Sam

    Hi, I tried your vowel replacement program. It works for single-line text files, but if there’s more than 1 line, the program seems to break down. Even the first line isn’t “translated” properly.

    Input:
    This is line One.
    This is line Two.

    Output:
    This#is#lin# On#.
    Thi# i# li#e#Two#

    This only thing I changed was the .dat extension to .txt

    Seems like the ‘new line’ character screws up the either the get or put pointer, although this doesn’t explain why even the first line isn’t working properly.

    • Hi Sam/Alex,

      My results were not quite the same as Sam’s but the code did not work.

      The problem I believe lies in the seekg(0, ios::cur) call after we output the ‘#’. As far as I can make out this is not good enough to convince the io system that something has happened (internally it optimises away the call to fseek and I think that means its idea of where we are is not correct).

      Change that line for these two:

      iofile.seekg( -1, ios::cur );
      iofile.seekg( 1, ios::cur );

      That worked for me.

      What I can’t understand is why we don’t need to use seekp (instead of seekg) before the write…

      Grant

      • I think you can also use:

        iofile.seekg( iofile.tellg(), ios::beg);

        Grant

        • Hmmm, that is interesting about seekg(0, ios::cur) not working for you. It worked fine for me, but maybe it is being optimized away in your case as you suggest.

          I added a short blurb about tellg() and tellp() to the tutorial and also changed the example to use iofile.seekg(iofile.tellg(), ios::beg);, though I do have some concerns about the performance ramificaitons of doing such a thing (not sure if it’s smart enough to convert that into a relative position, or whether it’s going back to the beginning of the file each time and then counting it out).

          As for the seekg()/seekp() difference, as far as I can tell with fstream they appear to be identical.

  • dekaya

    I modified your code slightly to get it to work on my win2k machine.
    using dev-cpp

    I added :

  • Hello
    why this code is true?
    [code]

    #include
    #include
    using namespace std;

    int main()
    {
    int b[4]={1,1,5,1};
    int c[4]={0};
    fstream A(“File.txt”,ios::binary|ios::in|ios::out);

    if(!A)
    {
    return 1;
    }
    A.write((char *) (&b),sizeof(b));//(&b) must be (b) but ?????!!!!!
    A.seekg(0);
    A.read((char *) (c),sizeof(c));
    cout<<c[2];
    return 0;
    }

  • Hello
    why this code is true?

  • Casey

    Is it possible to pass fstream objects as parameters? I am writing a simple function that calculates the size of a file stream passed to it. Here is the code.

    Any help is appreciated.

    Also, is there a tutorial on advanced operations with binary files? I’m writing a file archive application and I need a little help with the C++ filestream objects.
    I would like to weave files together byte by byte. I would also like to write variables, like the number and names of files in the archive, to the top of the file for easy reference.

    Thank you for these tutorials. They have been a great resource for me.

    • Casey

      I figured out my problem. The ios namespace lives inside std, so to use ios, I must also use std. My fstream parameters were being declared outside of their scope.

      Man, this stuff gets confusing!

  • hi..I want to find whether a string is present or not in a file which i have already written and its contents are being displayed…can someone help me with the code…

  • loift

    I need to do many manipulations on a file on a bit level. Is there a better way to do this than: (1)open the file in input mode (2)open a second file in output mode (3)read the input file as a string (4)individually convert each character of this string to its binary (ascii/utf-8) value and append/write this to the output file (5)do manipulations on the output file (6) manually convert the output file back by reading the output file as a string 8 “boolean” characters at a time and turning it into an ascii/utf-8 value.

  • Matt

    Typo ("it’s" should be "its"):
    * "- that is, skip around to various points in the file to read it’s contents."
    * "We’re going to write a program that opens a file, reads it’s contents, and changes the any vowels it finds to a ‘#’ symbol."

  • Aaron

    What do I do if I want to read/write a single line?
    Is there a way to seek by line, rather than by bytes?

    I want to write a database file that contains variable length entries, reads them into an array for sorting/printing etc, then writes them back to the file when I’m done.
    I figure that if every entry is on its own line, I can just read that entire line into each array element, and write them back the same way, but I don’t know how to do that.

    • Alex

      To read a single line, use getline().

      For what you want to do, I don’t think you need to seek by line. Just parse the entire database file upon load (using getline()), make your modifications to it in memory, and then write it back out when you’re done.

      As long as the file isn’t HUGE, this should work.

  • Lokesh

    #typo
    "One other bit of trickiness: Unlike istream," -> ifstream

  • Kodnot

    First of all, a few minor typos:
    1. Before the first big example: should be "Here’s" instead of "Heres";
    2. In "Reading and writing a file at the same time using fstream": "…and changes the any vowels it finds to a ‘#’ symbol" - no need for "the".

    Also, this code does not work for me unless the file is opened in binary mode. There is this quote: "The only seeking you can do in a text file is to the start of the file, to the current position, or to a streampos returned from a call to tell[gp]()." - random coder on bytes.com, and as far as I looked into it, seekg and seekp in other situations whilest dealing with such text files is undefined or unreliable. Maybe you should adress that in the tutorial^^

    • Alex

      Typos fixed. It looks like some compilers have a buggy implementation of seekg() and tellg() when used in text mode. I’ve added a note about trying binary mode in this case.

  • Hannah

    Hi,

    is it possible to delete the contents of a file between locations A and B?

    I’m assuming that would be more difficult than overwriting, because we’re changing the location of the remaining content?

    • Alex

      It’s generally a bad idea to try to add/delete content from the middle of a file. For this kind of thing, it’s easier to either:
      1) Read the whole file into memory, skipping the content you want to delete, then write the contents of memory back out to disk.
      2) Open a new file and copy all the parts of the source file you want to keep into the destination file. Then delete the source file and rename the destination file to the source file.

  • Sameeha Basha

    Hi,
    Why is it necessary to do a seek operation in order to switch between read and write?

    • Alex

      I don’t actually know. It must have something to do with the way the streams are implemented, but I don’t have enough in depth knowledge on that topic to say.

  • RWDavid

    Hi Alex 🙂
    Is there anyway to write into a file where it does not overwrite the existing characters? For example, you search for every vowel in the text file and you want to insert a ‘$’ after the vowel.

    I tried opening the file with the std::ios::app flag, but it only adds text at the end.

    • Alex

      The best way to do this is either to:
      1) Read the contents of the file into memory, modify the content in memory, and write them back out, or
      2) While you’re reading the contents of the file, write them out into a new file and make any additional changes at that point.

      Trying to insert bytes into the middle of files is a recipe for disaster.

  • LeoNardo

    hii
    I ‘m confusing about
    How to modify the content in file by random access

  • Kausthub

    Hi Alex
    You haven’t taught how to delete a record in a file having classes or structures

    • Alex

      Generally, adding anything to or removing anything from a file directly is a bad idea.

      You’re better off reading the contents of the file into memory, modifying them in memory, and then writing them out.

Leave a Comment

Put C++ code inside [code][/code] tags to use the syntax highlighter