SplitFilename - Split a filename into its components
 
 
 
SplitFilename - Split a filename into its components

This reference page is linked to from the following overview topics: Guidelines for Handling Character Strings.



Module description

These function is used to extract the path, filename and/or extension out of a fully-qualified path name.

Pass in NULL for components which you do not require.

Note that SplitFilename will also support being passed a GUID string representing an asset. Example: "{B5B12976-3C00-475A-A619-CE0C76BD8483}" If the IAssetManager can find an asset corresponding to this string, SplitFilename will use the filename of this asset.

        {
                CStr p, f, e;
                CStr name("c:\\mydir\\myfile.txt");
        
                SplitFilename(name, &p, &f, &e);
        
                // p now contains "c:\\mydir"
                // f now contains "myfile"
                // e now contains ".txt"
        }

        {
                WStr p;
                WStr name(L"c:\\mydir\\myfile.txt");

                SplitFilename(name, &p, NULL, NULL);    

                // p now contains L"c:\\mydir"
        }

        {
                wchar_t file[MAX_PATH];

                SplitFilename(L"c:\\mydir\\myfile.txt", NULL, file, NULL);

                // file now contains L"myfile"
        }
Parameters:
[in] full_path Full pathname, cannot be NULL.
[out] directory Extracted path name, with directory. Pass NULL if you do not need it.
[out] filename Extracted filename, without extension. Pass NULL if you do not need it.
[out] extension Extracted extension. Pass NULL if you do not need it. !

Functions

CoreExport void  SplitFilename (const CStr &full_path, CStr *directory, CStr *filename, CStr *extension)
  SplitFilename (CStr* version)
CoreExport void  SplitFilename (LPCSTR full_path, LPSTR directory, LPSTR filename, LPSTR extension)
  SplitFilename (char* version)
CoreExport void  SplitFilename (const WStr &full_path, WStr *directory, WStr *filename, WStr *extension)
  SplitFilename (WStr* version)
CoreExport void  SplitFilename (LPCWSTR full_path, LPWSTR directory, LPWSTR filename, LPWSTR extension)
  SplitFilename (wchar_t* version)

Function Documentation

CoreExport void SplitFilename ( const CStr full_path,
CStr directory,
CStr filename,
CStr extension 
)

SplitFilename (CStr* version)

CoreExport void SplitFilename ( LPCSTR  full_path,
LPSTR  directory,
LPSTR  filename,
LPSTR  extension 
)

SplitFilename (char* version)

CoreExport void SplitFilename ( const WStr full_path,
WStr directory,
WStr filename,
WStr extension 
)

SplitFilename (WStr* version)

CoreExport void SplitFilename ( LPCWSTR  full_path,
LPWSTR  directory,
LPWSTR  filename,
LPWSTR  extension 
)

SplitFilename (wchar_t* version)