7 ObjectTypes for the Vision System in General ToC Previous Next

7.6 RecipeTransferType ToC Previous Next

7.6.2 RecipeTransferType Methods ToC Previous Next

7.6.2.1 GenerateFileForRead ToC

This method is used to start the read file transaction. A successful call of this method creates a temporary FileType Object with the file content and returns the NodeId of this Object and the file handle to access the Object.

Signature

GenerateFileForRead ([in]	RecipeTransferOptions	generateOptions[out]	NodeId	fileNodeId[out]	UInt32	fileHandle[out]	NodeId	completionStateMachine);

Table 50 – GenerateFileForRead Method Arguments

Argument Description
generateOptions The structure used to define the generate options for the file, described in Section 12.11.
fileNodeId NodeId of the temporary file
fileHandle The fleHandle of the opened TransferFile.
The fileHandle can be used to access the TransferFile methods Read and Close.
completionStateMachine If the creation of the file is completed asynchronously, the parameter returns the NodeId of the corresponding FileTransferStateMachineType Object.
If the creation of the file is already completed, the parameter is null.
If a FileTransferStateMachineType object NodeId is returned, the Read Method of the file fails until the TransferState changed to ReadTransfer.

Table 51 – GenerateFileForRead Method AddressSpace Definition

Attribute Value
BrowseName GenerateFileForRead
References NodeClass BrowseName DataType TypeDefinition ModellingRule
HasProperty Variable InputArguments Argument[] PropertyType Mandatory
HasProperty Variable OutputArguments Argument[] PropertyType Mandatory

7.6.2.2 GenerateFileForWrite ToC

This method is used to start the write file transaction. A successful call of this method creates a temporary FileType Object with the file content and returns the NodeId of this Object and the file handle to access the Object.

Signature

GenerateFileForWrite ([in]	RecipeTransferOptions	generateOptions[out]	NodeId	fileNodeId[out]	UInt32	fileHandle);

Table 52 – GenerateFileForWrite Method Arguments

Argument Description
generateOptions The structure used to define the generate options for the file, described in Section 12.11.
fileNodeId NodeId of the temporary file
fileHandle The fleHandle of the opened TransferFile.
The fileHandle can be used to access the TransferFile methods Write and CloseAndCommit.

Table 53 – GenerateFileForWrite Method AddressSpace Definition

Attribute Value
BrowseName GenerateFileForWrite
References NodeClass BrowseName DataType TypeDefinition ModellingRule
HasProperty Variable InputArguments Argument[] PropertyType Mandatory
HasProperty Variable OutputArguments Argument[] PropertyType Mandatory

Previous Next