TrackingServicesLoadSubAssembly Method |
Loads a particular sub-assembly into a particular parent assembly.
If a position is specified, and another assembly is already loaded into that position, the method
will not succeed (no exception will be thrown, but return object will indicate the failure).
Namespace:
FactoryLogix.xTend.Production
Assembly:
FactoryLogix.xTend.API (in FactoryLogix.xTend.API.dll) Version: 8.245.0.0 (8.245.0.0)
Syntax public SubAssemblyLoadResult LoadSubAssembly(
Guid sessionId,
Guid transactionId,
Nullable<Guid> parentItemId,
Nullable<int> position,
Guid subAssyItemId,
SubAssemblyLoadVerifications verifications,
string reference = null
)
Public Function LoadSubAssembly (
sessionId As Guid,
transactionId As Guid,
parentItemId As Nullable(Of Guid),
position As Nullable(Of Integer),
subAssyItemId As Guid,
verifications As SubAssemblyLoadVerifications,
Optional reference As String = Nothing
) As SubAssemblyLoadResult
public:
virtual SubAssemblyLoadResult^ LoadSubAssembly(
Guid sessionId,
Guid transactionId,
Nullable<Guid> parentItemId,
Nullable<int> position,
Guid subAssyItemId,
SubAssemblyLoadVerifications verifications,
String^ reference = nullptr
) sealed
abstract LoadSubAssembly :
sessionId : Guid *
transactionId : Guid *
parentItemId : Nullable<Guid> *
position : Nullable<int> *
subAssyItemId : Guid *
verifications : SubAssemblyLoadVerifications *
?reference : string
(* Defaults:
let _reference = defaultArg reference null
*)
-> SubAssemblyLoadResult
override LoadSubAssembly :
sessionId : Guid *
transactionId : Guid *
parentItemId : Nullable<Guid> *
position : Nullable<int> *
subAssyItemId : Guid *
verifications : SubAssemblyLoadVerifications *
?reference : string
(* Defaults:
let _reference = defaultArg reference null
*)
-> SubAssemblyLoadResult
Parameters
- sessionId
- Type: SystemGuid
The session identifier that was returned by the Connect(String, String, String, String, String) method. - transactionId
- Type: SystemGuid
The transaction Id returned by the TransactionId property of the StartResult. - parentItemId
- Type: SystemNullableGuid
The optional Id of the parent Item. This is only required if the transaction
is associated with more than one parent assembly Items. - position
- Type: SystemNullableInt32
An optional numeric position, starting with number 1, designating the location where the sub-assembly was installed within the parent assembly. - subAssyItemId
- Type: SystemGuid
The Id of the Item representing the sub-assembly to be installed. - verifications
- Type: FactoryLogix.xTend.DataObjectsSubAssemblyLoadVerifications
A flagged enumeration indicating the verification checks that should be performed prior to allowing the sub-assebmly to be installed. - reference (Optional)
- Type: SystemString
An optional parameter representing the reference location where the sub-assebmly is to be installed.
Return Value
Type:
SubAssemblyLoadResultA
SubAssemblyLoadResult object with details regarding the result of the sub-assembly load operation.
Exceptions Exception | Condition |
---|
InvalidSessionException | Thrown if the sessionId parameter is invalid. |
ItemException | Thrown if the parentItemId parameter is non-null and is invalid, the parentItemId is null and the transaction is for multiple products, or if the subAssyItemId parameter is invalid. |
TransactionNotFoundException | Thrown if the transactionId parameter is invalid. |
See Also