FactoryTalk Optix 1.8.0 帮助

配方模式的方法和事件

配方模式中的方法和事件，包括它们的参数和结果。

方法

下表介绍方法及相关参数：

可通过 IDE 和 C# API 使用的方法
方法	输入参数	输出参数
CreateRecipe 在存储中创建新配方。	RecipeId [RecipeId]	Result [CreateRecipeResultCode] 成功：配方已成功创建缺少配方ID：调用该方法时使用了空配方ID 配方已存在：已存在同名且版本相同的配方存储错误：访问存储区时出错错误：发生错误
DuplicateRecipe 使用新标识符复制现有配方。	RecipeId [RecipeId] NewRecipeId [RecipeId]	Result [DuplicateRecipeResultCode] 成功：配方已成功复制通用错误：配方复制期间发生常规错误存储错误：访问存储时出错（例如，数据库错误）源配方名称意外为空：提供的源配方名称为空或 null 目标配方名称意外为空：提供的目标配方名称为空或 null 源配方不存在：在存储区中未找到源配方目标配方已存在：具有目标名称的配方已存在未找到目标：未找到用于配方复制的目标节点
RenameRecipe 重命名现有配方。	RecipeId [RecipeId] NewName [String]	Result [RenameRecipeResultCode] 成功：配方已成功重命名通用错误：配方重命名期间发生常规错误存储错误：访问存储时出错（例如，数据库错误）配方名称意外为空：提供的配方名称为空或 null 源配方不存在：在存储区中未找到源配方目标配方已存在：具有目标名称的配方已存在
DeleteRecipe 从存储中删除现有配方。	RecipeId [RecipeId]	Result [DeleteRecipeResultCode] 成功：配方已成功删除通用错误：删除配方期间发生常规错误存储错误：访问存储时出错（例如，数据库错误）配方名称意外为空：提供的配方名称为空或 null 配方不存在：在存储区中未找到指定配方
重构异步执行重构操作。	无	无。这是唯一的异步方法。操作完成后，将调度一个事件（重构已完成）。
GetDataItems 检索与配方关联的数据条目。	RecipeId [RecipeId]	Result [GetDataItemsResultCode] 成功：已成功检索到数据项未找到配方：在存储区中未找到指定的配方存储错误：访问存储时出错（例如，数据库错误）通用错误：检索数据项时发生常规错误
SetRecipeDataItemValue 设置配方中特定数据条目的值。	RecipeId [RecipeId] ItemRelativeBrowsePath [String] DataItemRelativeBrowsePath [String] ElementAccess [ElementAccess] Value [BaseDataType]	Result [SetRecipeDataItemValueResultCode] 成功：配方数据项值已成功设置通用错误：设置数据条目值时发生常规错误存储错误：访问存储时出错（例如，数据库错误）未找到数据条目：在配方中未找到指定的数据项配方名称意外为空：提供的配方名称为空或 null 未找到配方：在存储区中未找到指定的配方
SetRecipeMetadataValue 设置配方中特定元数据字段的值。	RecipeId [RecipeId] MetadataName [String] Value [BaseDataType]	Result [SetRecipeMetadataValueResultCode] 成功：配方元数据值已成功设置通用错误：设置元数据值时发生常规错误存储错误：访问存储时出错（例如，数据库错误）配方名称意外为空：提供的配方名称为空或 null 未找到配方：在存储区中未找到指定的配方未找到元数据：在配方中未找到指定的元数据字段
TransferFromEditModelToStore 将配方从编辑模型传输到存储。	RequesterNodeId [NodeId] RecipeId [RecipeId]	Result [TransferFromEditModelToStoreResultCode] 成功配方已创建：配方已成功创建并从编辑模型传输到存储区成功配方已更新：配方已成功更新并从编辑模型传输到存储区通用错误：从编辑模型传输到存储区期间发生常规错误存储错误：访问存储时出错（例如，数据库错误）未找到请求者节点：未找到请求者节点配方名称意外为空：提供的配方名称为空或 null 未找到目标：未找到用于传输的目标节点 EditModelNodeNotFound：未找到编辑模型节点
TransferFromEditModelToTarget 将配方从编辑模型传输到目标节点。	RequesterNodeId [NodeId] TargetNodeId [NodeId] ErrorPolicy [ErrorPolicyDataType]	Result [TransferFromEditModelToTargetResultCode] 成功：配方已成功从编辑模型传输到目标通用错误：从编辑模型传输到目标期间发生常规错误存储错误：访问存储时出错（例如，数据库错误）未找到请求者节点：未找到请求者节点未找到目标：未找到用于传输的目标节点 EditModelNodeNotFound：未找到编辑模型节点数据不匹配：编辑模型数据与目标结构不匹配
TransferFromStoreToEditModel 将配方从存储传输到编辑模型。	RequesterNodeId [NodeId] RecipeId [RecipeId]	Result [TransferFromEditModelToTargetResultCode] 成功：配方已成功从编辑模型传输到目标通用错误：从编辑模型传输到目标期间发生常规错误存储错误：访问存储时出错（例如，数据库错误）未找到请求者节点：未找到请求者节点未找到目标：未找到用于传输的目标节点 EditModelNodeNotFound：未找到编辑模型节点数据不匹配：编辑模型数据与目标结构不匹配
TransferFromStoreToTarget 将配方从存储传输到目标节点。	RecipeId [RecipeId] TargetNodeId [NodeId] ErrorPolicy [ErrorPolicyDataType]	Result [TransferFromStoreToTargetResultCode] 成功：配方已成功从存储区转移到目标通用错误：从存储区传输到目标期间发生常规错误存储错误：访问存储时出错（例如，数据库错误）配方名称意外为空：提供的配方名称为空或 null 未找到配方：在存储区中未找到指定的配方未找到目标：未找到用于传输的目标节点数据不匹配：配方数据与目标结构不匹配
TransferFromTargetToEditModel 将配方从目标节点传输到编辑模型。	RequesterNodeId [NodeId] TargetNodeId [NodeId] ErrorPolicy [ErrorPolicyDataType]	Result [TransferFromTargetToEditModelResultCode] 成功：配方已成功从目标传输到编辑模型通用错误：从目标传输到编辑模型期间发生常规错误存储错误：访问存储时出错（例如，数据库错误）未找到请求者节点：未找到请求者节点未找到目标：未找到用于传输的目标节点 EditModelNodeNotFound：未找到编辑模型节点数据不匹配：目标数据与编辑模型结构不匹配
TransferFromTargetToStore 将配方从目标节点传输到存储区。	RecipeId [RecipeId] TargetNodeId [NodeId] Overwrite [Bool] ErrorPolicy [ErrorPolicyDataType]	Result [TransferFromTargetToStoreResultCode] 成功配方已创建：配方已成功创建并从目标传输到存储区成功配方已更新：配方已成功更新并从目标传输到存储区通用错误：从目标传输到存储区期间发生常规错误存储错误：访问存储时出错（例如，数据库错误）配方名称意外为空：提供的配方名称为空或 null 配方已存在：存储区中已存在同名的配方未找到目标：未找到用于传输的目标节点数据不匹配：目标数据与存储区结构不匹配

仅可通过 C# API 使用的方法
方法	输入参数	输出参数
GetRecipes 检索存储中所有配方的列表。	无输入参数	Result [GetRecipesResult] (Array) 成功：已成功检索到配方存储错误：访问存储区时出错通用错误：检索配方时发生常规错误
GetRecipeMetadataValue 检索配方中特定元数据字段的值。	RecipeId [RecipeId] MetadataName [String]	Result [GetRecipeMetadataValueResult] 成功：已成功检索到配方元数据值通用错误：检索元数据值时发生常规错误存储错误：访问存储区时出错配方名称意外为空：提供的配方名称为空或 null 未找到配方：在存储区中未找到指定的配方未找到元数据：在配方中未找到指定的元数据字段
GetRecipeMetadataValues 检索与配方关联的所有元数据值。	RecipeId [RecipeId]	Result [GetRecipeMetadataValuesResult] 成功：已成功检索到配方元数据值通用错误：检索元数据值时发生常规错误存储错误：访问存储区时出错配方名称意外为空：提供的配方名称为空或 null 未找到配方：在存储区中未找到指定的配方
GetRecipeDataItemValue 检索配方中特定数据条目的值。	RecipeId [RecipeId] ItemRelativeBrowsePath [String] (Array) DataItemRelativeBrowsePath [String] (Array) ElementAccess [ElementAccess]	Result [GetRecipeDataItemValueResult] 成功：已成功检索到配方数据项的值通用错误：检索数据项值时发生常规错误存储错误：访问存储区时出错未找到数据条目：在配方中未找到指定的数据项配方名称意外为空：提供的配方名称为空或 null 未找到配方：在存储区中未找到指定的配方
CreateEditModel 创建配方的编辑模型。	ParentNodeId [NodeId] RequesterNodeId [NodeId] TargetNodeId [NodeId] RecipeId [RecipeId]	Result [CreateEditModelResultCode] 成功：编辑模型已成功创建通用错误：创建编辑模型时发生常规错误存储错误：访问存储区时出错未找到父节点：未找到编辑模型的父节点未找到请求者节点：未找到请求者节点
TransferFromStores 将配方从存储传输到目标节点。	RecipeId [RecipeId]	Result [TransferFromStoreResultCode] 成功：已成功从存储区传输配方通用错误：从存储区传输过程中发生常规错误存储错误：访问存储区时出错未找到配方：在存储区中未找到指定的配方未找到目标：未找到用于传输的目标节点
TransferToStore 将配方传输到存储区。	RecipeId [RecipeId]	Result [TransferToStoreResultCode] 成功：配方已成功传输到存储区通用错误：传输到存储区过程中发生常规错误存储错误：访问存储区时出错
传输到目标将配方传输到目标节点。	TargetNodeId [NodeId] ErrorPolicy [ErrorPolicy]	Result [TransferToTargetResultCode] 成功：配方已成功传输到目标通用错误：传输到目标过程中发生常规错误存储错误：访问存储区时出错未找到目标：未找到用于传输的目标节点数据不匹配：配方数据与目标结构不匹配
TransferFromTarget 将配方从目标节点传输到存储区。	TargetNodeId [NodeId] ErrorPolicy [ErrorPolicy]	Result [TransferFromTargetResultCode] 成功：已成功从目标传输配方通用错误：从目标传输期间发生常规错误存储错误：访问存储区时出错未找到目标：未找到用于传输的目标节点数据不匹配：目标数据与配方结构不匹配
SetDataItemValue 设置特定数据条目的值。	ItemId [NodeId] DataItemRelativeBrowsePath [String] (Array) ElementAccess [ElementAccess] DataTypeId [NodeId] Value [BaseDataType]	Result [SetDataItemValueResultCode] 成功：数据条目值已成功设置通用错误：设置数据条目值时发生常规错误存储错误：访问存储区时出错未找到数据条目：未找到指定的数据项。

事件

配方模式包括以下事件：

重构已完成: 在重构方法完成时触发。
配方应用程序事件: 当 TransferFromStoreToTarget 或 TransferEditModelToTarget 完成时触发。

提供反馈

对本文档有问题或反馈吗？请在这里提交您的反馈。

Normal