RetrieveFile Method

Called by the PACSFramework to retrieve the file specified by row from the external store to the local store

Syntax

C#
Visual Basic
Objective-C
Java
C++

Exception RetrieveFile( 
   DataRow row,
   string outFile
)

'Declaration
 
Function RetrieveFile( _
   ByVal row As DataRow, _
   ByVal outFile As String _
) As Exception

'Usage
 
Dim instance As ICrud
Dim row As DataRow
Dim outFile As String
Dim value As Exception
 
value = instance.RetrieveFile(row, outFile)

Exception^ RetrieveFile( 
   DataRow^ row,
   String^ outFile
)

Parameters

row: A DataRow containing the external store token
outFile: The fully specified local store location where the external store file should be copied

Return Value

null if successful; otherwise return an appropriate exception. Note that the exception is returned and not thrown.

Remarks

row is a DataRow that represents a row of the 'Instance' table. row will be passed by the framework, and the corresponding external store token can be extracted by calling:

            string token = Leadtools.Medical.Storage.DataAccessLayer.RegisteredDataRows.InstanceInfo.StoreToken(row);

For an example, see the Leadtools.Medical.ExternalStore.Sample.Addin demo located here: <INSTALLDIR>\Examples\PACSFramework\CS\Sample AddIns\Leadtools.Medical.ExternalStore.Sample.Addin

Requirements

Target Platforms

Reference

ICrud Interface
ICrud Members