GDAL
Public Member Functions | Public Attributes | List of all members
GDALOpenInfo Class Reference

Class for dataset open functions. More...

#include <gdal_priv.h>

Public Member Functions

 GDALOpenInfo (const char *pszFile, int nOpenFlagsIn, char **papszSiblingFiles=NULL)
 Constructor/. More...
 
int TryToIngest (int nBytes)
 Ingest bytes from the file. More...
 
char ** GetSiblingFiles ()
 Return sibling files. More...
 
char ** StealSiblingFiles ()
 Return sibling files and steal reference. More...
 
bool AreSiblingFilesLoaded () const
 Return whether sibling files have been loaded. More...
 

Public Attributes

char * pszFilename
 Filename.
 
char ** papszOpenOptions
 Open options.
 
GDALAccess eAccess
 Access flag.
 
int nOpenFlags
 Open flags.
 
int bStatOK
 Whether stat()'ing the file was successful.
 
int bIsDirectory
 Whether the file is a directory.
 
VSILFILEfpL
 Pointer to the file.
 
int nHeaderBytes
 Number of bytes in pabyHeader.
 
GBytepabyHeader
 Buffer with first bytes of the file.
 
const char *const * papszAllowedDrivers
 Allowed drivers (NULL for all)
 

Detailed Description

Class for dataset open functions.

Constructor & Destructor Documentation

GDALOpenInfo::GDALOpenInfo ( const char *  pszFilenameIn,
int  nOpenFlagsIn,
char **  papszSiblingsIn = NULL 
)

Constructor/.

Parameters
pszFilenameInfilename
nOpenFlagsInopen flags
papszSiblingsInlist of sibling files, or NULL.

Member Function Documentation

bool GDALOpenInfo::AreSiblingFilesLoaded ( ) const

Return whether sibling files have been loaded.

Returns
true or false.
char ** GDALOpenInfo::GetSiblingFiles ( )

Return sibling files.

Returns
sibling files. Ownership below to the object.
char ** GDALOpenInfo::StealSiblingFiles ( )

Return sibling files and steal reference.

Returns
sibling files. Ownership below to the caller (must be freed with CSLDestroy)
int GDALOpenInfo::TryToIngest ( int  nBytes)

Ingest bytes from the file.

Parameters
nBytesnumber of bytes to ingest.
Returns
TRUE if successful

The documentation for this class was generated from the following files:

Generated for GDAL by doxygen 1.8.8.