Back to Aurora Vision Studio website

You are here: Start » Filter Reference » GenICam » GenICam_DownloadFile

GenICam_DownloadFile


Module: Genicam

Downloads a file from a GenICam device using the File Access Control interface.

Name Type Description
Input value inAddress GenAddress GenTL Provider module and device identifying address
Input value inScope GenICamParameterScope Specifies which parameters set in GenICam stack should be accessed
Input value inFileName String Name of the file to download
Output value outBuffer ByteBuffer Content of the downloaded file

Description

This filter is intended for cooperation with a general camera device through a GenTL compliant provider. Its purpose is to download a file from the device using the GenICam File Access Control interface. The device must be implementing the File Control Access interface as specified by the GenICam Standard Function Naming Convention (SFNC) standard for the filter to work.

Device address (inAddress port) is a structure defining a unique device and its GenTL provider module in the system. It is recommended to use the GenTL Device Manager (click the "..." button in Filter Properties) to select the appropriate device, connected to the local system, whose identification information will be used.

The inFileName input specifies the name of the file to be downloaded. Available file names can be determined by examining the allowed values of the FileSelector parameter in the device parameters tree.

On successful completion, the outBuffer output returns a ByteBuffer with data content of the entire file. The data size depends on the file size.

This filter does not maintain the connection with the device. When there are no other active GenICam filters connected with the same device, the connection will be closed after the filter execution is finished.

For general information about working with GenTL devices, please refer to the following article.

Hints

  • Interactively select a camera available in your network by defining the inAddress input.

Errors

This filter can throw an exception to report error. Read how to deal with errors in Error Handling.

List of possible exceptions:

Error type Description
DomainError Empty file name on input of GenICam_DownloadFile.

Complexity Level

This filter is available on Advanced Complexity Level.

Disabled in Lite Edition

This filter is disabled in Lite Edition. It is available only in full, Aurora Vision Studio Professional version.

See Also

  • GenICam_UploadFile – Uploads a file to a GenICam device using the File Access Control interface.
  • Application Notes - set of documents about connecting devices or establishing communication with Aurora Vision Studio.