bool   sgFileManager::GetFileHeader(const char* file_name, SG_FILE_HEADER& file_header)

 

Description:

Returns the file header structure (read more how to save the scene here).

Arguments:

file_name - full path to a file the scene will be saved to

file_header - returned file header structure.

This structure has the following description

typedef struct

 {

         char                    signature[5];  

         int                       major_ver;

         int                       minor_ver;

                 unsigned long   userBlockSize;

 } SG_FILE_HEADER;

 

signature - standard file signature (defined through SG_FILE_SIGNATURE)

major_ver - major kernel version the file was created by (more about the version - sgGetVerson)

minor_ver - minor kernel version the file was created by  (more about the version - sgGetVerson)

userBlockSize - size of user-defined block of data which is saved right after the header in the file. You can get the user-defined block of data itself using the GetUserData function.

 

Returned value:

Returns true if the specified file is a file with sgCore objects, otherwise false

 

 

 

See also:

GetUserData