Document revision date: 15 July 2002

Finds entries in a directory.

Format

#include <dirent.h>

struct dirent *readdir (DIR *dir_pointer);

int readdir_r (DIR *dir_pointer, struct dirent *entry, struct dirent **result);

Arguments

dir_pointer

A pointer to the dir structure of an open directory.

entry

A pointer to a dirent structure that will be initialized with the directory entry at the current position of the specified stream.

result

Upon successful completion, the location where a pointer to entry is stored.

Description

The readdir function returns a pointer to a structure representing the directory entry at the current position in the directory stream specified by dir_pointer, and positions the directory stream at the next entry. It returns a NULL pointer upon reaching the end of the directory stream. The dirent structure defined in the <dirent.h> header file describes a directory entry.

The type DIR defined in the <dirent.h> header file represents a directory stream. A directory stream is an ordered sequence of all the directory entries in a particular directory. Directory entries represent files. You can remove files from or add files to a directory asynchronously to the operation of the readdir function.

The pointer returned by the readdir function points to data that you can overwrite by another call to readdir on the same directory stream. This data is not overwritten by another call to readdir on a different directory stream.

If a file is removed from or added to the directory after the most recent call to the opendir or rewinddir function, a subsequent call to the readdir function might not return an entry for that file.

When it reaches the end of the directory, or when it detects an invalid seekdir operation, the readdir function returns the null value.

An attempt to seek to an invalid location causes the readdir function to return the null value the next time it is called. A previous telldir function call returns the position.

The readdir_r function is a reentrant version of readdir . In addition to dir_pointer, you must specify a pointer to a dirent structure in which the current directory entry of the specified stream is returned.

If the operation is successful, readdir_r returns 0 and stores one of the two following pointers in result:

• Pointer to entry if the entry was found
• NULL pointer if the end of the directory stream was reached

If an error occurred, an error value is returned that indicates the cause of the error.

The storage pointed to by entry must be large enough for a dirent with an array of char d_name member containing at least NAME_MAX + 1 elements.

Example

See the description of closedir for an example.

Return Values

x	On successful completion of readdir , a pointer to an object of type struct dirent .
0	Successful completion of readdir_r .
x	On error, an error value ( readdir_r only).
NULL	An error occurred or end of the directory stream ( readdir_r only). If an error occurred, errno is set to a value indicating the cause.

Changes the size of the area pointed to by the first argument to the number of bytes given by the second argument. These functions are AST-reentrant.

Format

#include <stdlib.h>

void *realloc (void *ptr, size_t size);

Arguments

ptr

Points to an allocated area, or can be NULL.

size

The new size of the allocated area.

Description

If ptr is the NULL pointer, the behavior of the realloc function is identical to the malloc function.

The contents of the area are unchanged up to the lesser of the old and new sizes. The ANSI C Standard states that, "If the new size is larger than the old size, the value of the newly allocated portion of memory is indeterminate." For compatibility with old implementations, Compaq C initializes the newly allocated memory to 0.

For efficiency, the previous actual allocation could have been larger than the requested size. If it was allocated with malloc , the value of the portion of memory between the previous requested allocation and the actual allocation is indeterminate. If it was allocated with calloc , that same memory was initialized to 0. If your application relies on realloc initializing memory to 0, then use calloc instead of malloc to perform the initial allocation.

See also free , cfree , calloc , and malloc in this section.

Return Values

x	The address of the area, quadword-aligned. The address is returned because the area may have to be moved to a new address to reallocate enough space. If the area was moved, the space previously occupied is freed.
NULL	Indicates that space cannot be reallocated (for example, if there is not enough room).

Repaint the specified window on the terminal screen. The refresh function acts on the stdscr window.

Format

#include <curses.h>

int refresh();

int wrefresh (WINDOW *win);

Argument

win

A pointer to the window.

Description

The result of this process is that the portion of the window not occluded by subwindows or other windows appears on the terminal screen. To see the entire occluded window on the terminal screen, call the touchwin function instead of the refresh or wrefresh function.

See also touchwin in this section.

Return Values

OK	Indicates success.
ERR	Indicates an error.

Deletes a file.

Format

#include <stdio.h>

int remove (const char *file_spec);

Argument

file_spec

A pointer to the string that is an OpenVMS or a UNIX style file specification. The file specification can include a wildcard in its version number. So, for example, files of the form filename.txt;* can be deleted.

Description

If you specify a directory in the file name and it is a search list that contains an error, Compaq C for OpenVMS Systems interprets it as a file error.

The remove and delete functions are functionally equivalent in the Compaq C RTL.

See also delete in this section.

Return Values

0	Indicates success.
nonzero value	Indicates failure.

Gives a new name to an existing file.

Format

#include <stdio.h>

int rename (const char *old_file_spec, const char *new_file_spec);

Arguments

old_file_spec

A pointer to a string that is the existing name of the file to be renamed.

new_file_spec

A pointer to a string that is to be the new name of the file.

Description

If you try to rename a file that is currently open, the behavior is undefined. You cannot rename a file from one physical device to another. Both the old and new file specifications must reside on the same device.

If the new_file_spec does not contain a file extension, the file extension of old_file_spec is used. To rename a file to have no file extension, new_file_spec must contain a period (.) For example, the following renames SYS$DISK:[]FILE.DAT to SYS$DISK:[]FILE1.DAT:

rename("file.dat", "file1");

However, the following renames SYS$DISK:[]FILE.DAT to SYS$DISK:[]FILE1:

rename(file.dat", "file1.");

Note Because the rename function does special processing of the file extension, the caller must be careful when specifying the name of the renamed file in a call to a C Run-Time Library function that accepts a file-name argument. For example, after the following call to the rename function, the new file should be opened as fopen("bar.dat",...) : rename("foo.dat", "bar");

Return Values

0	Indicates success.
nonzero value	Indicates failure.

Sets the file to its beginning.

Format

#include <stdio.h>

void rewind (FILE *file_ptr); (ISO POSIX-1)

int rewind (FILE *file_ptr); (COMPAQ C EXTENSION)

Argument

file_ptr

A file pointer.

Description

The rewind function is equivalent to fseek (file_ptr, 0, SEEK_SET) . You can use the rewind function with either record or stream files.

A successful call to rewind clears the error indicator for the file.

The ANSI C standard defines rewind as not returning a value; therefore, the function prototype for rewind is declared with a return type of void . However, since a rewind can fail, and since previous versions of the Compaq C RTL have declared rewind to return an int , the code for rewind does return 0 on success and - 1 on failure.

See also fseek in this section.

Resets the position of the specified directory stream to the beginning of a directory.

Format

#include <dirent.h>

void rewinddir (DIR *dir_pointer);

Arguments

dir_pointer

A pointer to the dir structure of an open directory.

Description

The rewinddir function resets the position of the specified directory stream to the beginning of the directory. It also causes the directory stream to refer to the current state of the corresonding directory, the same as using the opendir function. If the dir_pointer argument does not refer to a directory stream, the effect is undefined.

The type DIR , defined in the <dirent.h> header file, represents a directory stream. A directory stream is an ordered sequence of all the directory entries in a particular directory. Directory entries represent files.

See also opendir in this section.

Searches for a character in a string.

Format

#include <strings.h>

char *rindex (const char *s, int c);

Arguments

s

The string to search.

c

The character to search for.

Description

The rindex function is identical to the strchr function, and is provided for compatibility with some UNIX implementations.

Rounds its argument to an integral value according to the current IEEE rounding direction specified by the user.

Format

#include <math.h>

double rint (double x);

float rintf (float x,);

long double rintl (long double x);

Argument

x

A real number.

Description

The rint functions return the nearest integral value to x in the direction of the current IEEE rounding mode specified on the /ROUNDING_MODE command-line qualifier.

If the current rounding mode rounds toward negative Infinity, then rint is identical to floor . If the current rounding mode rounds toward positive Infinity, then rint is identical to ceil .

If |x| = Infinity, rint returns x.

Return Values

n	The nearest integral value to x in the direction of the current IEEE rounding mode.
NaN	x is NaN; errno is set to EDOM.

Removes a directory file.

Format

#include <unistd.h>

int rmdir (const char *path);

Arguments

path

A directory pathname.

Description

The rmdir function removes a directory file whose name is specified in the path argument. The directory is removed only if it is empty.

Restriction

When using OpenVMS format names, the path argument must be in the form directory.dir.

Return Values

0	Indicates success.
- 1	An error occurred; errno is set to indicate the error.

Determines the lowest virtual address that is not used with the program.

Format

#include <unistd.h>

void *sbrk (long int incr);

Argument

incr

The number of bytes to add to the current break address.

Description

The sbrk function adds the number of bytes specified by its argument to the current break address and returns the old break address.

When a program is executed, the break address is set to the highest location defined by the program and data storage areas. Consequently, sbrk is needed only by programs that have growing data areas.

sbrk(0) returns the current break address.

Return Values

x	The old break address.
( void *)( - 1)	Indicates that the program is requesting too much memory.

Restriction

Unlike other C library implementations, the Compaq C RTL memory allocation functions (such as malloc ) do not rely on brk or sbrk to manage the program heap space. Consequently, on OpenVMS systems, calling brk or sbrk can interfere with memory allocation routines. The brk and sbrk functions are provided only for compatibility purposes.

Returns the exponent of a floating-point number.

Format

#include <math.h>

double scalb (double x, double n);

float scalbf (float x, float n);

long double scalbl (long double x, long double n);

Arguments

x

A nonzero floating-point number.

n

An integer.

Description

The scalb functions return x*(2**n) for integer n.

Return Values

x	On successful completion, x*(2** n) is returned.
±HUGE_VAL	On overflow, scalb returns ±HUGE_VAL (according to the sign of x) and sets errno to ERANGE.
0	Underflow occurred; errno is set to ERANGE.
x	x is ±Infinity.
NaN	x or n is NaN; errno is set to EDOM.

Performs formatted input from the standard input ( stdin ), interpreting it according to the format specification. See Chapter 2 for information on format specifiers.

Format

#include <stdio.h>

int scanf (const char *format_spec, ...);

Arguments

format_spec

Pointer to a string containing the format specification. The format spcification consists of characters to be taken literally from the input or converted and placed in memory at the specified input sources. For a list of conversion characters, see Chapter 2.

...

Optional expressions that are pointers to objects whose resultant types correspond to conversion specifications given in the format specification.

If no conversion specifications are given, you can omit these input pointers. Otherwise, the function call must have at least as many input pointers as there are conversion specifications, and the conversion specifications must match the types of the input pointers.

Conversion specifications are matched to input sources in left-to-right order. Excess input pointers, if any, are ignored.

Return Values

x	The number of successfully matched and assigned input items.
EOF	Indicates that a read error occurred prior to any successful conversions.The function sets errno . For a list of errno values set by this function, see fscanf in this section.

	privacy and legal statement
5763PRO_045.HTML