1
0
mirror of https://github.com/lammertb/libhttp.git synced 2025-04-19 11:02:13 +03:00
libhttp/doc/api/httplib_opendir.md
2016-12-15 21:16:33 +01:00

1.4 KiB

LibHTTP API Reference

httplib_opendir( name );

Parameters

Parameter Type Description
name const char * A pointer to name of the directory to open

Return Value

Type Description
DIR * A pointer to a directory structure or NULL on error

Description

The function httplib_opendir() provides a platform independent way to open a directory on a system. The function uses the Posix opendir() function in environments where that function is supported or emulates that function with own code for other operating systems. The function is either a pointer to a DIR directory structure if the call was succesful, or a NULL pointer if the directory cannot be found or an other error occured.

Reading individual items in the directory is possible with the httplib_readdir() function.

Please note that the httplib_opendir() function allocates memory and opens the directory as a file on most platforms. Closing the directory and returning the allocated resources after use of the directory is finished is therefore necessary. Closing a directory can be done with a call to the httplib_closedir() function.

See Also