ProcessServicesGetProcess Method |
Retrieves a single process definition, given its ID.
Namespace:
FactoryLogix.xTend.ProcessDefinition
Assembly:
FactoryLogix.xTend.API (in FactoryLogix.xTend.API.dll) Version: 8.245.0.0 (8.245.0.0)
Syntax public Process GetProcess(
Guid sessionId,
Guid processId,
bool loadMaterial = false
)
Public Function GetProcess (
sessionId As Guid,
processId As Guid,
Optional loadMaterial As Boolean = false
) As Process
public:
virtual Process^ GetProcess(
Guid sessionId,
Guid processId,
bool loadMaterial = false
) sealed
abstract GetProcess :
sessionId : Guid *
processId : Guid *
?loadMaterial : bool
(* Defaults:
let _loadMaterial = defaultArg loadMaterial false
*)
-> Process
override GetProcess :
sessionId : Guid *
processId : Guid *
?loadMaterial : bool
(* Defaults:
let _loadMaterial = defaultArg loadMaterial false
*)
-> Process
Parameters
- sessionId
- Type: SystemGuid
The session identifier that was returned by the Connect(String, String, String, String, String) method. - processId
- Type: SystemGuid
The unique identifier (ID) of the process being requested. - loadMaterial (Optional)
- Type: SystemBoolean
Set to true to load material lists from Part Assignments to operations. Default is false
Return Value
Type:
ProcessA
Process object whose Id property matches the processId parameter.
Exceptions Exception | Condition |
---|
InvalidSessionException | Thrown if the sessionId parameter is invalid. |
NotFoundException | An existing process with matching Id property was not found in the system, or was found but is a process template. |
See Also