SBLaunchInfo#

class lldb.SBLaunchInfo(argv)#

Describes how a target or program should be launched.

Methods Summary

AddCloseFileAction(SBLaunchInfo self, int fd)

AddDuplicateFileAction(SBLaunchInfo self, ...)

AddOpenFileAction(SBLaunchInfo self, int fd, ...)

AddSuppressFileAction(SBLaunchInfo self, ...)

Clear(SBLaunchInfo self)

GetArgumentAtIndex(SBLaunchInfo self, ...)

GetDetachOnError(SBLaunchInfo self)

GetEnvironment()

Return the environment variables of this object.

GetEnvironmentEntryAtIndex(...)

GetExecutableFile(SBLaunchInfo self)

GetGroupID(SBLaunchInfo self)

GetLaunchEventData(SBLaunchInfo self)

GetLaunchFlags(SBLaunchInfo self)

GetListener()

Get the listener that will be used to receive process events.

GetNumArguments(SBLaunchInfo self)

GetNumEnvironmentEntries(SBLaunchInfo self)

GetProcessID(SBLaunchInfo self)

GetProcessPluginName(SBLaunchInfo self)

GetResumeCount(SBLaunchInfo self)

GetScriptedProcessClassName(SBLaunchInfo self)

GetScriptedProcessDictionary(SBLaunchInfo self)

GetShadowListener()

Get the shadow listener that receive public process events, additionally to the default process event listener.

GetShell(SBLaunchInfo self)

GetShellExpandArguments(SBLaunchInfo self)

GetUserID(SBLaunchInfo self)

GetWorkingDirectory(SBLaunchInfo self)

GroupIDIsValid(SBLaunchInfo self)

SetArguments(SBLaunchInfo self, ...)

SetDetachOnError(SBLaunchInfo self, bool enable)

SetEnvironment(env, append)

Update this object with the given environment variables.

SetEnvironmentEntries(envp, append)

Update this object with the given environment variables.

SetExecutableFile(exe_file, add_as_first_arg)

Set the executable file that will be used to launch the process and optionally set it as the first argument in the argument vector.

SetGroupID(SBLaunchInfo self, uint32_t gid)

SetLaunchEventData(SBLaunchInfo self, ...)

SetLaunchFlags(SBLaunchInfo self, uint32_t flags)

SetListener(listener)

Set the listener that will be used to receive process events.

SetProcessPluginName(SBLaunchInfo self, ...)

SetResumeCount(SBLaunchInfo self, uint32_t c)

SetScriptedProcessClassName(...)

SetScriptedProcessDictionary(...)

SetShadowListener(listener)

Set the shadow listener that will receive public process events, additionally to the default process event listener.

SetShell(SBLaunchInfo self, char const * path)

SetShellExpandArguments(SBLaunchInfo self, ...)

SetUserID(SBLaunchInfo self, uint32_t uid)

SetWorkingDirectory(SBLaunchInfo self, ...)

UserIDIsValid(SBLaunchInfo self)

Methods Documentation

AddCloseFileAction(SBLaunchInfo self, int fd) → bool#
AddDuplicateFileAction(SBLaunchInfo self, int fd, int dup_fd) → bool#
AddOpenFileAction(SBLaunchInfo self, int fd, char const * path, bool read, bool write) → bool#
AddSuppressFileAction(SBLaunchInfo self, int fd, bool read, bool write) → bool#
Clear(SBLaunchInfo self)#
GetArgumentAtIndex(SBLaunchInfo self, uint32_t idx) → char const *#
GetDetachOnError(SBLaunchInfo self) → bool#
GetEnvironment()#

Return the environment variables of this object.

Return type:

SBEnvironment

Returns:

An lldb::SBEnvironment object which is a copy of the SBLaunchInfo’s environment.

GetEnvironmentEntryAtIndex(SBLaunchInfo self, uint32_t idx) → char const *#
GetExecutableFile(SBLaunchInfo self) → SBFileSpec#
GetGroupID(SBLaunchInfo self) → uint32_t#
GetLaunchEventData(SBLaunchInfo self) → char const *#
GetLaunchFlags(SBLaunchInfo self) → uint32_t#
GetListener()#

Get the listener that will be used to receive process events.

If no listener has been set via a call to SBLaunchInfo::SetListener(), then an invalid SBListener will be returned (SBListener::IsValid() will return false). If a listener has been set, then the valid listener object will be returned.

GetNumArguments(SBLaunchInfo self) → uint32_t#
GetNumEnvironmentEntries(SBLaunchInfo self) → uint32_t#
GetProcessID(SBLaunchInfo self) → lldb::pid_t#
GetProcessPluginName(SBLaunchInfo self) → char const *#
GetResumeCount(SBLaunchInfo self) → uint32_t#
GetScriptedProcessClassName(SBLaunchInfo self) → char const *#
GetScriptedProcessDictionary(SBLaunchInfo self) → SBStructuredData#
GetShadowListener()#

Get the shadow listener that receive public process events, additionally to the default process event listener.

If no listener has been set via a call to SBLaunchInfo::SetShadowListener(), then an invalid SBListener will be returned (SBListener::IsValid() will return false). If a listener has been set, then the valid listener object will be returned.

GetShell(SBLaunchInfo self) → char const *#
GetShellExpandArguments(SBLaunchInfo self) → bool#
GetUserID(SBLaunchInfo self) → uint32_t#
GetWorkingDirectory(SBLaunchInfo self) → char const *#
GroupIDIsValid(SBLaunchInfo self) → bool#
SetArguments(SBLaunchInfo self, char const ** argv, bool append)#
SetDetachOnError(SBLaunchInfo self, bool enable)#
SetEnvironment(env, append)#

Update this object with the given environment variables.

If append is false, the provided environment will replace the existing environment. Otherwise, existing values will be updated of left untouched accordingly.

Parameters:

  • [in] – env The new environment variables.

  • [in] – append Flag that controls whether to replace the existing environment.

SetEnvironmentEntries(envp, append)#

Update this object with the given environment variables.

If append is false, the provided environment will replace the existing environment. Otherwise, existing values will be updated of left untouched accordingly.

Parameters:

  • [in] –

    envp The new environment variables as a list of strings with the following format

    name=value

  • [in] – append Flag that controls whether to replace the existing environment.

SetExecutableFile(exe_file, add_as_first_arg)#

Set the executable file that will be used to launch the process and optionally set it as the first argument in the argument vector.

This only needs to be specified if clients wish to carefully control the exact path will be used to launch a binary. If you create a target with a symlink, that symlink will get resolved in the target and the resolved path will get used to launch the process. Calling this function can help you still launch your process using the path of your choice.

If this function is not called prior to launching with SBTarget::Launch(…), the target will use the resolved executable path that was used to create the target.

Parameters:

  • exe_file (SBFileSpec, in) – The override path to use when launching the executable.

  • add_as_first_arg (boolean, in) – If true, then the path will be inserted into the argument vector prior to launching. Otherwise the argument vector will be left alone.

SetGroupID(SBLaunchInfo self, uint32_t gid)#
SetLaunchEventData(SBLaunchInfo self, char const * data)#
SetLaunchFlags(SBLaunchInfo self, uint32_t flags)#
SetListener(listener)#

Set the listener that will be used to receive process events.

By default the SBDebugger, which has a listener, that the SBTarget belongs to will listen for the process events. Calling this function allows a different listener to be used to listen for process events.

SetProcessPluginName(SBLaunchInfo self, char const * plugin_name)#
SetResumeCount(SBLaunchInfo self, uint32_t c)#
SetScriptedProcessClassName(SBLaunchInfo self, char const * class_name)#
SetScriptedProcessDictionary(SBLaunchInfo self, SBStructuredData dict)#
SetShadowListener(listener)#

Set the shadow listener that will receive public process events, additionally to the default process event listener.

By default a process have no shadow event listener. Calling this function allows public process events to be broadcasted to an additional listener on top of the default process event listener. If the listener argument is invalid (SBListener::IsValid() will return false), this will clear the shadow listener.

SetShell(SBLaunchInfo self, char const * path)#
SetShellExpandArguments(SBLaunchInfo self, bool expand)#
SetUserID(SBLaunchInfo self, uint32_t uid)#
SetWorkingDirectory(SBLaunchInfo self, char const * working_dir)#
UserIDIsValid(SBLaunchInfo self) → bool#