whereami.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	WAI_FUNCSPEC
#define	WAI_PREFIX(function)   wai_##function

Functions
WAI_FUNCSPEC int WAI_PREFIX()	getExecutablePath (char *out, int capacity, int *dirname_length)
WAI_FUNCSPEC int WAI_PREFIX()	getModulePath (char *out, int capacity, int *dirname_length)

Macro Definition Documentation

WAI_FUNCSPEC

#define WAI_FUNCSPEC

Definition at line 10 of file whereami.h.

WAI_PREFIX

#define WAI_PREFIX

(

function

)

wai_##function

Definition at line 13 of file whereami.h.

Function Documentation

getExecutablePath()

WAI_FUNCSPEC int WAI_PREFIX() getExecutablePath	(	char *	out,
		int	capacity,
		int *	dirname_length
	)

Returns the path to the current executable.

Usage:

• first call int length = wai_getExecutablePath(NULL, 0, NULL); to retrieve the length of the path
• allocate the destination buffer with path = (char*)malloc(length + 1);
• call wai_getExecutablePath(path, length, NULL) again to retrieve the path
• add a terminal NUL character with ‘path[length] = ’\0';`

Parameters

out	destination buffer, optional
capacity	destination buffer capacity
dirname_length	optional recipient for the length of the dirname part of the path.

Returns

the length of the executable path on success (without a terminal NUL character), otherwise -1

getModulePath()

WAI_FUNCSPEC int WAI_PREFIX() getModulePath	(	char *	out,
		int	capacity,
		int *	dirname_length
	)

Returns the path to the current module

Usage:

• first call int length = wai_getModulePath(NULL, 0, NULL); to retrieve the length of the path
• allocate the destination buffer with path = (char*)malloc(length + 1);
• call wai_getModulePath(path, length, NULL) again to retrieve the path
• add a terminal NUL character with ‘path[length] = ’\0';`

Parameters

out	destination buffer, optional
capacity	destination buffer capacity
dirname_length	optional recipient for the length of the dirname part of the path.

Returns

the length of the module path on success (without a terminal NUL character), otherwise -1