Click or drag to resize

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.242.0.0 (8.242.0.0)
Syntax
public SubAssemblyLoadResult LoadSubAssembly(
	Guid sessionId,
	Guid transactionId,
	Nullable<Guid> parentItemId,
	Nullable<int> position,
	Guid subAssyItemId,
	SubAssemblyLoadVerifications verifications,
	string reference = null
)

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: SubAssemblyLoadResult
A SubAssemblyLoadResult object with details regarding the result of the sub-assembly load operation.
Exceptions
ExceptionCondition
InvalidSessionExceptionThrown if the sessionId parameter is invalid.
ItemExceptionThrown 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.
TransactionNotFoundExceptionThrown if the transactionId parameter is invalid.
See Also