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

GenICam_DownloadFile

This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code.

Header:	Genicam.h
Namespace:	avs
Module:	Genicam

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

Syntax

void avs::GenICam_DownloadFile
(
	const avl::GenAddress& inAddress,
	avl::GenICamParameterScope::Type inScope,
	const atl::String& inFileName,
	avl::ByteBuffer& outBuffer
)

Parameters

Name	Type	Description
inAddress	const GenAddress&	GenTL Provider module and device identifying address
inScope	GenICamParameterScope::Type	Specifies which parameters set in GenICam stack should be accessed
inFileName	const String&	Name of the file to download
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 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.

Hints

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

Errors

List of possible exceptions: