How to use the string::getline STL function in Visual C++ (158200)


The information in this article applies to:

  • The Standard C++ Library, when used with:
    • Microsoft Visual C++, 32-bit Enterprise Edition 4.2
    • Microsoft Visual C++, 32-bit Enterprise Edition 5.0
    • Microsoft Visual C++, 32-bit Enterprise Edition 6.0
    • Microsoft Visual C++, 32-bit Professional Edition 4.2
    • Microsoft Visual C++, 32-bit Professional Edition 5.0
    • Microsoft Visual C++, 32-bit Professional Edition 6.0
    • Microsoft Visual C++, 32-bit Learning Edition 6.0
    • Microsoft Visual C++ 2005 Express Edition
    • Microsoft Visual C++ .NET (2003)
    • Microsoft Visual C++ .NET (2002)
This article was previously published under Q158200
Note Microsoft Visual C++ .NET 2002 and Microsoft Visual C++ .NET 2003 support both the managed code model that is provided by the Microsoft .NET Framework and the unmanaged native Microsoft Windows code model. The information in this article applies only to unmanaged Visual C++ code. Microsoft Visual C++ 2005 supports both the managed code model that is provided by the Microsoft .NET Framework and the unmanaged native Microsoft Windows code model.

SUMMARY

The sample code below illustrates how to use the string::getline STL function in Visual C++.

MORE INFORMATION

Required header

   <string>

Prototype

  template<class _E, class _TYPE, class _A> inline
  basic_istream<_E, _TYPE>& getline( basic_istream<_E, _TYPE>& Istream,
                            basic_string<_E, _TYPE, _A>& Xstring,
                            const _E _D=_TYPE::newline());
Note The class/parameter names in the prototype may not match the version in the header file. Some have been modified to improve readability.

Description

The getline function creates a string containing all of the characters from the input stream until one of the following situations occurs:
  • End of file.
  • The delimiter is encountered.
  • is.max_str() elements have been extracted.

Sample code

////////////////////////////////////////////////////////////////////// 
// 
// Compile options needed: /GX
// 
// Getline.cpp : Illustrates how to use the getline function to read a
//               line of text from the keyboard.
// 
// Functions:
// 
//    getline       Returns a string from the input stream.
// 
// Written by Derek Jamison
// of Microsoft Product Support Services,
// Copyright (c) 1996 Microsoft Corporation. All rights reserved.
////////////////////////////////////////////////////////////////////// 

#pragma warning(disable:4786)
#include <string>
#include <iostream>
using namespace std;

#if _MSC_VER > 1020   // if VC++ version is > 4.2
   using namespace std;  // std c++ libs implemented in std
   #endif

void main()
{
    string s1;
    cout << "Enter a sentence (use <space> as the delimiter):";
    getline(cin,s1, ' ');
    cout << "You entered: " << s1;
}
Program Output is:
Enter a sentence (use <space> as the delimiter): A_space_at_the_end.
You entered: A_space_at_the_end.

REFERENCES

For the same topic about string::getline, visit the following MSDN Web site: http://msdn.microsoft.com/library/en-us/vclang98/html/sample_stringCCgetline_(STL_Sample).asp?frame=true
Modification Type:MajorLast Reviewed:1/10/2006
Keywords:kbProgramming kbhowto kbcode kbinfo KB158200 kbAudDeveloper
©2004 Microsoft Corporation. All rights reserved.