# IInputFileParameters

Description:

`IInputFileParameters` is a collection for managing the input files of a `Job`.
```cpp
import "OxSvrSpt.idl"
```
Public Methods:
```cpp
HRESULT Delete ([in] VARIANT Index)
HRESULT Clear ()
HRESULT AddExistFile ([in] BSTR FileName, [in, defaultvalue(0)] VARIANT_BOOL AutoDelete, [out, retval] IFileParameter ** ppNewParameter)
HRESULT AddTempFile ([in, defaultvalue(0xffff)] VARIANT_BOOL AutoDelete, [in, defaultvalue("tmp")] BSTR FileExtension, [out, retval] IFileParameter ** ppNewParameter)
```
Properties:
```cpp
long Count [get]
```
```cpp
IFileParameter Item([in] VARIANT Index) [get]
```
Documentation of Element Functions:

* `HRESULT AddExistFile ([in] BSTR FileName, [in, defaultvalue(0)] VARIANT_BOOL AutoDelete, [out, retval] IFileParameter ** ppNewParameter)`

`AddExistFile` adds an existing file as a new `FileParameter` and returns it.

The passed file is not deleted by default.

It is checked whether the file exists. It is only opened when accessing its data through the methods of the IFileParameter interface.

Parameters:

: `FileName` name of the file.

: `AutoDelete` (default value: VARIANT_FALSE) indicates whether the file should be automatically deleted by this class after use.

: `ppNewParameter` (VB return value) corresponding `FileParameter` object.

* `HRESULT AddTempFile ([in, defaultvalue(0xffff)] VARIANT_BOOL AutoDelete, [in, defaultvalue("tmp")] BSTR FileExtension, [out, retval] IFileParameter ** ppNewParameter)`

`AddTempFile` creates a `File` parameter and automatically creates a temporary file for data transfer to the server.

This file is deleted by default after use.

In case of need, the file name can be determined via the FileName property of the returned IFileParameter object.

Parameters:

: `AutoDelete` (default value: VARIANT_FALSE) indicates whether the file should be automatically deleted by this class after use.

: `FileExtension` (default value: tmp) specifies a file extension for the temporary file.

: `ppNewParameter` (VB return value) corresponding `FileParameter` object.

* `HRESULT Clear ()`

`Clear` removes all elements from the collection.

* `HRESULT Delete ([in] VARIANT Index)`

`Delete` deletes the parameter based on position in the list or name.

Parameters:

: `Index` name or position of the license entry to be deleted.

Documentation of Properties:

* `long Count [get]`

`Count` returns the number of elements in the collection.

Parameters:

: `plNumber` (VB return value) number of elements in the collection.

* `IFileParameter Item([in] VARIANT Index) [get]`

`Item` returns the specified element of the collection based on position or key.

If a position outside the valid index is specified, an error with the error value `errCollectionIndexOutOfRange` is returned. If the item cannot be found, an error with the value `errCollectionItemNotFound` is returned.

Parameters:

: `Index` position or name of the requested element.

: `ppItem` (VB return value) corresponding `FileParameter` object.