_get_pgmptr

Gets the current value of the _pgmptr global variable.

Syntax

errno_t _get_pgmptr(
   char **pValue
);

Parameters

pValue
A pointer to a string to be filled with the current value of the _pgmptr variable.

Return value

Returns zero if successful; an error code on failure. If pValue is NULL, the invalid parameter handler is invoked as described in Parameter validation. If execution is allowed to continue, this function sets errno to EINVAL and returns EINVAL.

Remarks

Only call _get_pgmptr if your program has a narrow entry point, like main() or WinMain(). The _pgmptr global variable contains the full path to the executable associated with the process. For more information, see _pgmptr, _wpgmptr.

By default, this function's global state is scoped to the application. To change this behavior, see Global state in the CRT.

Requirements

Routine	Required header
_get_pgmptr	<stdlib.h>

For more compatibility information, see Compatibility.

See also

_get_wpgmptr