Workspace IPC
PBWorkspaceRunFlags
Enumeration/bitset of type uint32_t:
Constants
PBWorkspaceRun_ACTIVATE_ONLY
PBWorkspaceRun_ACTIVATE_ONLY = 1<<0
PBWorkspaceRun_CONNECT
PBWorkspaceRun_CONNECT = 1<<1
PBWorkspaceRunConfiguration
Structure:
Fields
flags (PBWorkspaceRunFlags): Flags bitwise OR-ed together controlling the run command.
embeddedViewID (uint64_t
): 0 if the new window should not be embedded. Otherwise, set this to the ID of the embedded view in which to show the created window, from PBEmbeddedViewGetID.
PBWorkspaceRun
Function:
Syntax (C/C++)
bool PBWorkspaceRun(ConstStr runCommand, PBWorkspaceRunFlags flags,
/* output */ uint64_t * _Nullable __restrict windowID);
Syntax (Python)
WorkspaceRun(runCommand, flags) -> (success, windowID)
Parameters and Return Values
[in] runCommand (referenced string):
[in] flags (PBWorkspaceRunFlags):
[out] success (bool
):
[optional-out] windowID (uint64_t
):
PBWorkspaceRun2
Function:
Syntax (C/C++)
bool PBWorkspaceRun2(ConstStr runCommand,
const PBWorkspaceRunConfiguration * __restrict configuration,
/* output */ uint64_t * _Nullable __restrict windowID);
Syntax (Python)
WorkspaceRun2(runCommand, configuration) -> (success, windowID)
Parameters and Return Values
[in] runCommand (referenced string):
[in] configuration (PBWorkspaceRunConfiguration):
[out] success (bool
):
[optional-out] windowID (uint64_t
):
PBWorkspaceRunSplit
Function:
Syntax (C/C++)
bool PBWorkspaceRunSplit(
const ConstStr *_Nullable runArguments, size_t runArgumentsCount,
PBWorkspaceRunFlags flags, /* output */ uint64_t * _Nullable __restrict windowID);
Syntax (Python)
WorkspaceRunSplit(runArguments, flags) -> (success, windowID)
Parameters and Return Values
[in] runArguments (referenced array of referenced string):
[in] flags (PBWorkspaceRunFlags):
[out] success (bool
):
[optional-out] windowID (uint64_t
):
PBWorkspaceIsProtocolHandled
Function:
Syntax (C/C++)
bool PBWorkspaceIsProtocolHandled(ConstStr protocol);
Syntax (Python)
WorkspaceIsProtocolHandled(protocol) -> (isHandled)
Parameters and Return Values
[in] protocol (referenced string):
[out] isHandled (bool
):