Back to FabImage Library website

You are here: Start » Function Reference » GigE Vision » FisFilter_GigEVision_UploadFile

FisFilter_GigEVision_UploadFile


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: fis
Module: Genicam

Uploads a file to a GigEVision device using the File Access Control interface.

Syntax

void fis::FisFilter_GigEVision_UploadFile
(
	const fil::GevAddress& inAddress,
	const ftl::String& inFileName,
	const fil::ByteBuffer& inBuffer
)

Parameters

Name Type Default Description
Input value inAddress const GevAddress& GigE Vision Device identifying address (IP, MAC or Serial Number)
Input value inFileName const String& Name of the file to write to
Input value inBuffer const ByteBuffer& Content of the file that will be uploaded

Description

This filter is intended for cooperation with a GigE Vision® compliant devices. Its purpose is to upload a file into 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 textual definition of either IP, MAC or serial number. Use Device Manager to select the appropriate address of a connected device.

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

The entire file is overwritten with data from the inBuffer input. This filter will first attempt to perform a "Delete" operation on the file, then it will upload the entire data from the inBuffer input ByteBuffer, starting from the zero offset.

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

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

To learn more about camera acquisition thread works please go to this article.

Hints

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

Errors

List of possible exceptions:

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