Final Platform Layer  0.9.6-beta
Functions
Path functions

This category contains functions for retrieving and building paths. More...

Functions

fpl_common_api size_t fplChangeFileExtension (const char *filePath, const char *newFileExtension, char *destPath, const size_t maxDestLen)
 Changes the file extension on the given source path and writes the result into a destination buffer. More...
 
const fpl_common_api char * fplExtractFileExtension (const char *sourcePath)
 Extracts the file extension from the given source path. More...
 
const fpl_common_api char * fplExtractFileName (const char *sourcePath)
 Extracts the file name including the file extension from the given source path. More...
 
fpl_common_api size_t fplExtractFilePath (const char *sourcePath, char *destPath, const size_t maxDestLen)
 Extracts the directory path from the given file path. More...
 
fpl_platform_api size_t fplGetExecutableFilePath (char *destPath, const size_t maxDestLen)
 Gets the full path to this executable, including the executable file name. More...
 
fpl_platform_api size_t fplGetHomePath (char *destPath, const size_t maxDestLen)
 Gets the full path to your home directory. More...
 
fpl_common_api size_t fplPathCombine (char *destPath, const size_t maxDestPathLen, const size_t pathCount,...)
 Combines all given paths by the platforms path separator for a fixed number of arguments. More...
 

Detailed Description

This category contains functions for retrieving and building paths.

Function Documentation

◆ fplChangeFileExtension()

fpl_common_api size_t fplChangeFileExtension ( const char *  filePath,
const char *  newFileExtension,
char *  destPath,
const size_t  maxDestLen 
)

Changes the file extension on the given source path and writes the result into a destination buffer.

Parameters
filePathThe File path to search for the extension
newFileExtensionThe new file extension
destPathThe destination buffer
maxDestLenThe total number of characters available in the destination buffer
Returns
Returns the number of required/written characters, excluding the null-terminator
See also
Changing the file extension

◆ fplExtractFileExtension()

const fpl_common_api char* fplExtractFileExtension ( const char *  sourcePath)

Extracts the file extension from the given source path.

Parameters
sourcePathThe source path to extract from
Returns
Returns the pointer to the first character of the extension.
See also
Extracting the file extension

◆ fplExtractFileName()

const fpl_common_api char* fplExtractFileName ( const char *  sourcePath)

Extracts the file name including the file extension from the given source path.

Parameters
sourcePathThe source path to extract from
Returns
Returns the pointer to the first character of the filename.
See also
Extracting the file name

◆ fplExtractFilePath()

fpl_common_api size_t fplExtractFilePath ( const char *  sourcePath,
char *  destPath,
const size_t  maxDestLen 
)

Extracts the directory path from the given file path.

Parameters
sourcePathThe source path to extract from
destPathThe destination buffer
maxDestLenThe total number of characters available in the destination buffer
Returns
Returns the number of required/written characters, excluding the null-terminator
See also
Extracting the file path

◆ fplGetExecutableFilePath()

fpl_platform_api size_t fplGetExecutableFilePath ( char *  destPath,
const size_t  maxDestLen 
)

Gets the full path to this executable, including the executable file name.

Parameters
destPathThe destination buffer
maxDestLenThe total number of characters available in the destination buffer
Returns
Returns the number of required/written characters, excluding the null-terminator
See also
Get executable file path

◆ fplGetHomePath()

fpl_platform_api size_t fplGetHomePath ( char *  destPath,
const size_t  maxDestLen 
)

Gets the full path to your home directory.

Parameters
destPathThe destination buffer
maxDestLenThe total number of characters available in the destination buffer
Returns
Returns the number of required/written characters, excluding the null-terminator
See also
Getting the home directory path

◆ fplPathCombine()

fpl_common_api size_t fplPathCombine ( char *  destPath,
const size_t  maxDestPathLen,
const size_t  pathCount,
  ... 
)

Combines all given paths by the platforms path separator for a fixed number of arguments.

Parameters
destPathThe destination buffer
maxDestPathLenThe total number of characters available in the destination buffer
pathCountThe number of dynamic path arguments
...The dynamic path arguments
Returns
Returns the number of required/written characters, excluding the null-terminator
See also
Combining paths