getw.md

description	title	ms.date	api_name	api_location	api_type	topic_type	f1_keywords	helpviewer_keywords	ms.assetid
Learn more about: _getw	_getw	4/2/2020	_getw _o__getw	msvcrt.dll msvcr80.dll msvcr90.dll msvcr100.dll msvcr100_clr0400.dll msvcr110.dll msvcr110_clr0400.dll msvcr120.dll msvcr120_clr0400.dll ucrtbase.dll api-ms-win-crt-stdio-l1-1-0.dll	DLLExport	apiref	_getw	_getw function integers, getting from streams getw function	ef75facc-b84e-470f-9f5f-8746c90822a0

_getw

Gets an integer from a stream.

Syntax

int _getw(
   FILE *stream
);

Parameters

stream
Pointer to the FILE structure.

Return value

_getw returns the integer value read. A return value of EOF indicates either an error or end of file. However, because the EOF value is also a legitimate integer value, use feof or ferror to verify an end-of-file or error condition. If stream is NULL, the invalid parameter handler is invoked, as described in Parameter validation. If execution is allowed to continue, errno is set to EINVAL and the function returns EOF.

Remarks

The _getw function reads the next binary value of type int from the file associated with stream and increments the associated file pointer (if one exists) to point to the next unread character. _getw doesn't assume any special alignment of items in the stream. Problems with porting can occur with _getw because the size of the int type and the ordering of bytes within the int type differ across systems.

By default, this function's global state is scoped to the application. To change this behavior, see Global state in the CRT.

Requirements

Routine	Required header
_getw	<stdio.h>

For more compatibility information, see Compatibility.

Example

// crt_getw.c
// This program uses _getw to read a word
// from a stream, then performs an error check.

#include <stdio.h>
#include <stdlib.h>

int main( void )
{
   FILE *stream;
   int i;

   if( fopen_s( &stream, "crt_getw.txt", "rb" ) )
      printf( "Couldn't open file\n" );
   else
   {
      // Read a word from the stream:
      i = _getw( stream );

      // If there is an error...
      if( ferror( stream ) )
      {
         printf( "_getw failed\n" );
         clearerr_s( stream );
      }
      else
         printf( "First data word in file: 0x%.4x\n", i );
      fclose( stream );
   }
}

Input: crt_getw.txt

Line one.
Line two.

Output

First data word in file: 0x656e694c

See also

Stream I/O
_putw