Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from http://www.ncbi.nlm.nih.gov/IEB/ToolBox/CPP_DOC/doxyhtml/group__Exec.html below:

NCBI C++ ToolKit: Process Creation and Execution

Error types that CExec can generate.

System error.

Spawn error.

Result interpretation error.

Definition at line 684 of file ncbiexec.hpp.

Flags defines what this class store.

Definition at line 141 of file ncbiexec.hpp.

Which exec mode the spawned process is called with.

Overlays calling process with new process, destroying calling process.

Suspends calling thread until execution of new process is complete (synchronous operation).

The same as eWait, but on UNIX platforms new process group will be created and calling process become the leader of the new process group.

Continues to execute calling process concurrently with new process (asynchronous spawn).

Do not forget to call Wait() to get process exit code, or started process will became a "zombie", even it has finished all work.

The same as eNoWait, but on UNIX platforms new process group will be created and calling process become the leader of the new process group.

Like eNoWait, continues to execute calling process; new process is run in background with no access to console or keyboard.

On UNIX new created process become the leader of the new session, the process group leader of the new process group. Calls to Wait() against new process will fail on MS Windows, but work on UNIX platforms. This is an asynchronous spawn.

Definition at line 87 of file ncbiexec.hpp.

Modification flags for EMode.

UNIX only: Move newly created process to a new group after fork() (assign new PGID).

This can be useful if new created process also spawns child processes and you wish to control it using signals, or for example, terminate the whole process group at once. These flag works on UNIX only, and will be ignored on MS Windows. Also, it doesn't work for eOverlay/eDetach modes.

Find command file to execute using PATH environment variable.

This can make any Spawn*() method to work similar to Spawn*P(). Mostly useful for generic Spawn() method, that don't have many variations.

Mask for all master modes, all EModeFlags must be declared above it.

Definition at line 66 of file ncbiexec.hpp.

Mode used to wait processes termination.

Wait any process to terminate.

Wait all processes to terminate.

Definition at line 564 of file ncbiexec.hpp.

Check executable permissions for specified file.

Note

This is no guarantee that the file is executable even if the function returns TRUE. It try to get effective user permissions for specified file, but sometimes this is not possible.

Parameters

path Path to the file to check.

Returns

TRUE if file is executable, FALSE otherwise.

See also

CFile::CheckAccess

Definition at line 993 of file ncbiexec.cpp.

References f, and CDirEntry::fExecute.

Referenced by CExec::ResolvePath().

Find executable file.

If necessary, the PATH environment variable is used to find the file to execute

Parameters

filename Name of the file to search.

Returns

Path to the executable file. kEmptyStr if not found, or the file do not have executable permissions.

See also

IsExecutable

Definition at line 1004 of file ncbiexec.cpp.

References _T_STDSTRING, _TX, env, NStr::fSplit_MergeDelimiters, NStr::fSplit_Truncate, CDir::GetCwd(), CDirEntry::GetPathSeparator(), CDirEntry::IsAbsolutePath(), CExec::IsExecutable(), ITERATE, kEmptyStr, CDirEntry::MakePath(), NcbiSys_getenv, CDirEntry::NormalizePath(), NPOS, NStr::Split(), CDirEntry::SplitPath(), and tmp.

Run console application in invisible mode.

MS Windows: This function try to run a program in invisible mode, without visible window. This can be used to run console program from non-console application. If it runs from console application, the parent's console window can be used by child process. Executing non-console program can show theirs windows or not, this depends. In eDetach mode the main window/console of the running program can be visible, use eNoWait instead.

Note

If the running program cannot self-terminate, that it can be never terminated. Unix: In current implementation equal to SpawnL().

Parameters

mode Mode for running the process. cmdname Path to the process to spawn. argv First argument vector parameter. ... Argument vector. Must ends with NULL.

Returns

On success, return:

• exit code - in eWait mode.
• process handle - in eNoWait and eDetach modes.
• nothing - in eOverlay mode. Throw an exception if command failed to execute.

See also

SpawnL(), TMode

Definition at line 906 of file ncbiexec.cpp.

References _T_XCSTRING, _T_XSTRING, _TX, CExec::eDetach, CExec::eNoWait, CExec::eOverlay, eV, CExec::eWait, FALSE, CExec::fModeMask, GetDiagContext(), NULL, CDiagContext::PrintStop(), CExec::QuoteArg(), RETURN_RESULT, s_GetRealMode(), s_QuoteSpawnArg(), s_SpawnUnix(), and XGET_EXEC_ARGS.

Spawn a new process.

CExec class have many different Spawn*() methods with specific sufficses in the method name: L, LP, LPE, V, VP, VPE. They are still there for backward compatibility. But this Spawn() can replace them all, it is more universal, uses modern syntax and don't require C-language legacy NULL values in the list of arguments or environment variables.

Parameters

cmdname Path to the process to spawn, or binary name args Vector of arguments. Can be empty if not used. env Vector with environment variables which will be used instead of current environment. Can be empty if not used. mode Mode for running the process. flags Additional flags for running the process.

Returns

On success, return:

• exit code - in eWait mode.
• process handle - in eNoWait and eDetach modes.
• nothing - in eOverlay mode. Throw an exception if command failed to execute.

See also

System, SpawnL(), SpawnLP(), SpawnLPE(), SpawnV(), SpawnVE(), SpawnVP(), SpawnVPE()

Definition at line 537 of file ncbiexec.cpp.

References _T_XCSTRING, _T_XSTRING, env, eV, eVE, eVP, eVPE, flags, CExec::fPath, GetDiagContext(), i, int, kEmptyStr, n, NCBI_THROW, NcbiSys_spawnv, NcbiSys_spawnve, NcbiSys_spawnvp, NcbiSys_spawnvpe, NULL, CDiagContext::PrintStop(), CExec::QuoteArg(), RETURN_RESULT, s_GetRealMode(), s_QuoteSpawnArg(), and s_SpawnUnix().

Referenced by CExec::Spawn().

Spawn a new process with specified command-line arguments.

In the SpawnL() version, the command-line arguments are passed individually. SpawnL() is typically used when number of parameters to the new process is known in advance.

Meaning of the suffix "L" in method name:

• The letter "L" as suffix refers to the fact that command-line arguments are passed separately as a list of arguments.

Parameters

mode Mode for running the process. cmdname Path to the process to spawn. argv First argument (char*). ... Additional argument(s) (char*). Must ends with NULL.

Returns

On success, return:

• exit code - in eWait mode.
• process handle - in eNoWait and eDetach modes.
• nothing - in eOverlay mode. Throw an exception if command failed to execute.

See also

Spawn, SpawnL(), SpawnLP(), SpawnLPE(), SpawnV(), SpawnVE(), SpawnVP(), SpawnVPE()

Definition at line 664 of file ncbiexec.cpp.

References _T_XCSTRING, eV, eVP, CExec::fPath, GetDiagContext(), int, NcbiSys_spawnv, NcbiSys_spawnvp, CDiagContext::PrintStop(), RETURN_RESULT, s_GetRealMode(), s_SpawnUnix(), and XGET_EXEC_ARGS.

Referenced by s_GetBigBedFeats(), s_GetBigBedSummary(), s_GetData(), CBamLoadingJob::x_CreateDataLoader(), and CWigGraph::x_RunBigWigScript().

Spawn a new process with specified command-line arguments and environment settings.

In the SpawnLE() version, the command-line arguments and environment pointer are passed individually. SpawnLE() is typically used when number of parameters to the new process and individual environment parameter settings are known in advance.

Meaning of the suffix "LE" in method name:

• The letter "L" as suffix refers to the fact that command-line arguments are passed separately as a list of arguments.
• The letter "E" as suffix refers to the fact that environment pointer, envp, is passed as an array of pointers to environment settings to the new process. The NULL environment pointer indicates that the new process will inherit the parents process's environment.

Parameters

mode Mode for running the process. cmdname Path of file to be executed. argv First argument (char*). ... Additional argument(s) (char*). Must ends with NULL. envp Pointer to a vector with environment variables which will be used instead of current environment. Last value in vector must be NULL.

Returns

On success, return:

• exit code - in eWait mode.
• process handle - in eNoWait and eDetach modes.
• nothing - in eOverlay mode. Throw an exception if command failed to execute.

See also

Spawn, SpawnL(), SpawnLP(), SpawnLPE(), SpawnV(), SpawnVE(), SpawnVP(), SpawnVPE()

Definition at line 689 of file ncbiexec.cpp.

References _T_XCSTRING, eVE, eVPE, CExec::fPath, GetDiagContext(), int, NcbiSys_spawnve, NcbiSys_spawnvpe, CDiagContext::PrintStop(), RETURN_RESULT, s_GetRealMode(), s_SpawnUnix(), XGET_EXEC_ARGS, and XGET_EXEC_ENVP.

Spawn a new process with variable number of command-line arguments and find file to execute from the PATH environment variable.

In the SpawnLP() version, the command-line arguments are passed individually and the PATH environment variable is used to find the file to execute. SpawnLP() is typically used when number of parameters to the new process is known in advance but the exact path to the executable is not known.

Meaning of the suffix "LP" in method name:

• The letter "L" as suffix refers to the fact that command-line arguments are passed separately as a list of arguments.
• The letter "P" as suffix refers to the fact that the PATH environment variable is used to find file to execute - on a Unix platform this feature works in functions without letter "P" in function name.

Parameters

mode Mode for running the process. cmdname Path of file to be executed. argv First argument (char*). ... Additional argument(s) (char*). Must ends with NULL.

Returns

On success, return:

• exit code - in eWait mode.
• process handle - in eNoWait and eDetach modes.
• nothing - in eOverlay mode. Throw an exception if command failed to execute.

See also

Spawn, SpawnL(), SpawnLP(), SpawnLPE(), SpawnV(), SpawnVE(), SpawnVP(), SpawnVPE()

Definition at line 715 of file ncbiexec.cpp.

References _T_XCSTRING, eVP, GetDiagContext(), NcbiSys_spawnvp, CDiagContext::PrintStop(), RETURN_RESULT, s_GetRealMode(), s_SpawnUnix(), and XGET_EXEC_ARGS.

Referenced by OpenFileBrowser(), and CAppPopup::PopupURL().

Spawn a new process with specified command-line arguments, environment settings and find file to execute from the PATH environment variable.

In the SpawnLPE() version, the command-line arguments and environment pointer are passed individually, and the PATH environment variable is used to find the file to execute. SpawnLPE() is typically used when number of parameters to the new process and individual environment parameter settings are known in advance, but the exact path to the executable is not known.

Meaning of the suffix "LPE" in method name:

• The letter "L" as suffix refers to the fact that command-line arguments are passed separately as a list of arguments.
• The letter "P" as suffix refers to the fact that the PATH environment variable is used to find file to execute - on a Unix platform this feature works in functions without letter "P" in function name.
• The letter "E" as suffix refers to the fact that environment pointer, envp, is passed as an array of pointers to environment settings to the new process. The NULL environment pointer indicates that the new process will inherit the parents process's environment.

Parameters

mode Mode for running the process. cmdname Path of file to be executed. argv First argument (char*). ... Additional argument(s) (char*). Must ends with NULL. envp Pointer to a vector with environment variables which will be used instead of current environment. Last value in an array must be NULL.

Returns

On success, return:

• exit code - in eWait mode.
• process handle - in eNoWait and eDetach modes.
• nothing - in eOverlay mode. Throw an exception if command failed to execute.

See also

Spawn, SpawnL(), SpawnLP(), SpawnLPE(), SpawnV(), SpawnVE(), SpawnVP(), SpawnVPE()

Definition at line 735 of file ncbiexec.cpp.

References _T_XCSTRING, eVPE, GetDiagContext(), NcbiSys_spawnvpe, CDiagContext::PrintStop(), RETURN_RESULT, s_GetRealMode(), s_SpawnUnix(), XGET_EXEC_ARGS, and XGET_EXEC_ENVP.

Spawn a new process with variable number of command-line arguments.

In the SpawnV() version, the command-line arguments are a variable number. If specified, the array of pointers to arguments must have a size of 2 or more and you must assign parameters for the new process beginning from argv[1].

Meaning of the suffix "V" in method name:

• The letter "V" as suffix refers to the fact that the number of command-line arguments are variable.

Parameters

mode Mode for running the process. cmdline Path of file to be executed. argv

• Argument vector. Arguments starts from index 1. Last value must be NULL.
• NULL, if argument list is empty.

Returns

On success, return:

• exit code - in eWait mode.
• process handle - in eNoWait and eDetach modes.
• nothing - in eOverlay mode. Throw an exception if command failed to execute.

See also

Spawn, SpawnL(), SpawnLP(), SpawnLPE(), SpawnV(), SpawnVE(), SpawnVP(), SpawnVPE()

Definition at line 756 of file ncbiexec.cpp.

References _T_XCSTRING, eV, eVP, CExec::fPath, GetDiagContext(), int, NcbiSys_spawnv, NcbiSys_spawnvp, CDiagContext::PrintStop(), RETURN_RESULT, s_GetRealMode(), s_SpawnUnix(), and XGET_PTR_ARGS.

Referenced by CBLASTSeqToolJob::x_CreateProjectItems().

Spawn a new process with variable number of command-line arguments and specified environment settings.

In the SpawnVE() version, the command-line arguments are a variable number. If specified, the array of pointers to arguments must have a size of 2 or more and you must assign parameters for the new process beginning from argv[1].

The individual environment parameter settings are known in advance and passed explicitly.

Meaning of the suffix "VE" in method name:

• The letter "V" as suffix refers to the fact that the number of command-line arguments are variable.
• The letter "E" as suffix refers to the fact that environment pointer, envp, is passed as an array of pointers to environment settings to the new process. The NULL environment pointer indicates that the new process will inherit the parents process's environment.

Parameters

mode Mode for running the process. cmdname Path of file to be executed. argv

• Argument vector. Arguments starts from index 1. Last value must be NULL.
• NULL, if argument list is empty.

envp Pointer to a vector with environment variables which will be used instead of current environment. Last value in an array must be NULL.

Returns

On success, return:

• exit code - in eWait mode.
• process handle - in eNoWait and eDetach modes.
• nothing - in eOverlay mode. Throw an exception if command failed to execute.

See also

Spawn, SpawnL(), SpawnLP(), SpawnLPE(), SpawnV(), SpawnVE(), SpawnVP(), SpawnVPE()

Definition at line 781 of file ncbiexec.cpp.

References _T_XCSTRING, eVE, eVPE, CExec::fPath, GetDiagContext(), int, NcbiSys_spawnve, NcbiSys_spawnvpe, CDiagContext::PrintStop(), RETURN_RESULT, s_GetRealMode(), s_SpawnUnix(), XGET_PTR_ARGS, and XGET_PTR_ENVP.

Spawn a new process with variable number of command-line arguments and find file to execute from the PATH environment variable.

In the SpawnVP() version, the command-line arguments are a variable number. If specified, the array of pointers to arguments must have a size of 2 or more and you must assign parameters for the new process beginning from argv[1].

The PATH environment variable is used to find the file to execute.

Meaning of the suffix "VP" in method name:

• The letter "V" as suffix refers to the fact that the number of command-line arguments are variable.
• The letter "P" as suffix refers to the fact that the PATH environment variable is used to find file to execute - on a Unix platform this feature works in functions without letter "P" in function name.

Parameters

mode Mode for running the process. cmdname Path of file to be executed. argv

• Argument vector. Arguments starts from index 1. Last value must be NULL.
• NULL, if argument list is empty.

Returns

On success, return:

• exit code - in eWait mode.
• process handle - in eNoWait and eDetach modes.
• nothing - in eOverlay mode. Throw an exception if command failed to execute.

See also

Spawn, SpawnL(), SpawnLP(), SpawnLPE(), SpawnV(), SpawnVE(), SpawnVP(), SpawnVPE()

Definition at line 808 of file ncbiexec.cpp.

References _T_XCSTRING, eVP, GetDiagContext(), NcbiSys_spawnvp, CDiagContext::PrintStop(), RETURN_RESULT, s_GetRealMode(), s_SpawnUnix(), and XGET_PTR_ARGS.

Referenced by CAgpconvertApplication::CAsnvalRunner::Notify().

Spawn a new process with variable number of command-line arguments and specified environment settings, and find the file to execute from the PATH environment variable.

In the SpawnVPE() version, the command-line arguments are a variable number. If specified, the array of pointers to arguments must have a size of 2 or more and you must assign parameters for the new process beginning from argv[1].

The PATH environment variable is used to find the file to execute, and the environment is passed via an environment vector pointer.

Meaning of the suffix "VPE" in method name:

• The letter "V" as suffix refers to the fact that the number of command-line arguments are variable.
• The letter "P" as suffix refers to the fact that the PATH environment variable is used to find file to execute - on a Unix platform this feature works in functions without letter "P" in function name.
• The letter "E" as suffix refers to the fact that environment pointer, envp, is passed as an array of pointers to environment settings to the new process. The NULL environment pointer indicates that the new process will inherit the parents process's environment.

Parameters

mode Mode for running the process. cmdname Path of file to be executed. argv

• Argument vector. Arguments starts from index 1. Last value must be NULL.
• NULL, if argument list is empty.

envp Pointer to a vector with environment variables which will be used instead of current environment. Last value in an array must be NULL.

Returns

On success, return:

• exit code - in eWait mode.
• process handle - in eNoWait and eDetach modes.
• nothing - in eOverlay mode. Throw an exception if command failed to execute.

See also

Spawn, SpawnL(), SpawnLP(), SpawnLPE(), SpawnV(), SpawnVE(), SpawnVP(), SpawnVPE()

Definition at line 828 of file ncbiexec.cpp.

References _T_XCSTRING, eVPE, GetDiagContext(), NcbiSys_spawnvpe, CDiagContext::PrintStop(), RETURN_RESULT, s_GetRealMode(), s_SpawnUnix(), XGET_PTR_ARGS, and XGET_PTR_ENVP.

Wait until any/all processes terminates.

Wait until any/all processes from specified list terminates. Return immediately if the specified processes has already terminated.

Parameters

handles List of process identifiers. Each identifier is a value returned by one of the Spawn* function in eNoWait and eDetach modes. Handles for terminated processes going to "result" list, and has been removed from this one. mode Wait termination for any or all possible processes within specified timeout. eWaitAny - wait until at least one process terminates. eWaitAll - wait until all processes terminates or timeout expires. result List of process handles/exitcodes of terminated processes from the list "handles". If this list have elements, that they will be removed. timeout Time interval in milliseconds (infinite by default) to wait.

Returns

• Number of terminated processes (size of the "result" list), if no errors. Regardless of timeout status.
• (-1), if error has occurred.

See also

Wait(), CProcess::Wait(), CProcess:IsAlive()

Definition at line 858 of file ncbiexec.cpp.

References CExec::eWaitAll, CExec::eWaitAny, CExec::CResult::exitcode, CExec::CResult::fBoth, CExec::CResult::handle, kInfiniteTimeoutMs, kWaitPrecision, CExec::CResult::m_Flags, CExec::CResult::m_Result, result, SleepMilliSec(), and CExec::Wait().

Wait until specified process terminates.

Wait until the process with "handle" terminates, and return immediately if the specified process has already terminated.

Parameters

handle Wait on process with identifier "handle", returned by one of the Spawn* function in eNoWait and eDetach modes. timeout Time interval in milliseconds (infinite by default) to wait.

Returns

• Exit code of the process, if no errors.
• (-1), if error has occurred.

Note

It is recommended to call this method for all processes started in eNoWait or eDetach modes (except on Windows for eDetach), because it release "zombie" processes, that finished working and waiting to return it's exit status. If Wait() is not called somewhere, the child process will be completely removed from the system only when the parent process ends.

See also

CProcess::Wait(), CProcess:IsAlive(), TMode

Definition at line 849 of file ncbiexec.cpp.

References CProcess::eHandle, and CProcess::Wait().

Referenced by s_SpawnUnix(), and CExec::Wait().

Definition at line 149 of file ncbiexec.hpp.

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4