osiProcess.h File Reference

Operating System Independent Interface to Process Environment. More...

#include "libComAPI.h"

Include dependency graph for osiProcess.h:

Go to the source code of this file.

Enumerations
enum	osiGetUserNameReturn { osiGetUserNameFail, osiGetUserNameSuccess }
enum	osiSpawnDetachedProcessReturn { osiSpawnDetachedProcessFail, osiSpawnDetachedProcessSuccess, osiSpawnDetachedProcessNoSupport }

Functions
LIBCOM_API osiGetUserNameReturn epicsStdCall	osiGetUserName (char *pBuf, unsigned bufSize)
	get user name More...
LIBCOM_API osiSpawnDetachedProcessReturn epicsStdCall	osiSpawnDetachedProcess (const char *pProcessName, const char *pBaseExecutableName)
	Spawn detached process. More...

Enumeration Type Documentation

enum osiGetUserNameReturn

Return code for osiGetUserName()

Enumerator
osiGetUserNameFail	Failed
osiGetUserNameSuccess	Succeeded

Definition at line 30 of file osiProcess.h.

enum osiSpawnDetachedProcessReturn

Return code for osiSpawnDetachedProcess()

Enumerator
osiSpawnDetachedProcessFail	Failed
osiSpawnDetachedProcessSuccess	Succeeded
osiSpawnDetachedProcessNoSupport	Not supported by OS

Definition at line 49 of file osiProcess.h.

Function Documentation

LIBCOM_API osiGetUserNameReturn epicsStdCall osiGetUserName	(	char *	pBuf,
		unsigned	bufSize
	)

Get the name of the user associated with the current process and copy the name into the provided buffer

Parameters

pBuf	buffer where user name is copied into
bufSize	size of input buffer.

Returns

return failed if unable to get user name or user name is too large to fit in buffer. Otherwise return success

LIBCOM_API osiSpawnDetachedProcessReturn epicsStdCall osiSpawnDetachedProcess	(	const char *	pProcessName,
		const char *	pBaseExecutableName
	)

Spawn detached process with named executable.

Parameters

pProcessName	process name to be displayed. Not used in all OSs
pBaseExecutableName	path to executable

Returns

return code indicating success or failure