7.5.2.9 UnlinkProduct
This method is used to remove the link between a recipe and a product in the vision system
Signature
UnlinkProduct ([in] RecipeIdInternalDataType internalId[in] ProductIdDataType productId[out] Int32 error);
| Argument | Description |
| internalId | Identification of the recipe used by the system. |
| productId | Identification of a product, the recipe is to be used for. |
| error | 0 – OK Values > 0 are reserved for errors defined by this and future standards. Values < 0 shall be used for application-specific errors. |
| Attribute | Value | ||||
| BrowseName | UnlinkProduct | ||||
| References | NodeClass | BrowseName | DataType | TypeDefinition | ModellingRule |
|---|---|---|---|---|---|
| HasProperty | Variable | InputArguments | Argument[] | PropertyType | Mandatory |
| HasProperty | Variable | OutputArguments | Argument[] | PropertyType | Mandatory |
It is expected that the vision system removes a link between recipes with the given InternalId and products with the given ProductId from its internal management structures.
UnlinkProduct uses the InternalId to ensure that it is unambiguous which recipe the link is removed from. If need be, the client can get the InternalIds for given ExternalIds using the GetRecipeListFiltered method (7.5.2.4).
Starting jobs based on this ProductId will no longer lead to this recipe being used. If there is no link left between this ProductId and any recipe, it will no longer be possible to start a job based on that ProductId.
If the server chooses to represent recipes in the Address Space, the server shall remove the given ProductId from the appropriate recipe node.
If the server chooses to represent products in the Address Space, and there are no recipes linked to a product anymore, it is expected that the server removes the corresponding product node.