IInputFileParameters

Beschreibung:

IInputFileParameters ist eine Collection für die Verwaltung der Input-Dateien eines Jobs .

import "OxSvrSpt.idl"

Öffentliche Methoden:

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:

long Count [get]
IFileParameter Item([in] VARIANT Index) [get]

Dokumentation der Elementfunktionen:

  • HRESULT AddExistFile ([in] BSTR FileName, [in, defaultvalue(0)]

  VARIANT_BOOL AutoDelete, [out, retval] IFileParameter **
  ppNewParameter)

AddExistFile fügt eine exisitierende Datei als neuen Fileparameter hinzu und liefert dieses zurück

Die übergebene Datei wird standarmäßig nicht gelöscht.

Es wird geprüft, ob die Datei existiert. Sie wird jedoch erst geöffnet, wenn über die betreffenden Methoden der IFileParameter-Schnittstelle auf deren Daten zugegriffen wird.

Parameter:

[in]: FileName Name der Datei .

[in]: AutoDelete (Standardwert: VARIANT_FALSE) gibt an, ob die Datei nach der Verwendung automatisch durch diese Klasse gelöscht werden soll.

[out]: ppNewParameter (VB-Rückgabewert) zugehöriges FileParameter -Objekt.

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

AddTempFile erzeugt einen File -Parameter und erstellt automatisch eine temporäre Datei für die Datenübergabe zum Server

Diese Datei wird standarmäßig nach der Verwendung gelöscht.

Im Bedarfsfall kann der Name der Datei kann über die Eigenschaft FileName des zurückgelieferten IFileParameter-Objektes ermittelt werden.

Parameter:

[in]: AutoDelete (Standardwert: VARIANT_FALSE) gibt an, ob die Datei nach der Verwendung automatisch durch diese Klasse gelöscht werden soll.

[in]: FileExtension (Standardwert: tmp) gibt für die temporäre Datei eine Dateiendung vor.

[out]: ppNewParameter (VB-Rückgabewert) zugehöriges FileParameter -Objekt.

  • HRESULT Clear ()

Clear entfernt alle Elemente der Collection.

  • HRESULT Delete ([in] VARIANT Index)

Delete löscht den Parameter anhand der Position in der Lister oder dem Namen.

Parameter:

[in]: Index Name oder Position des zu löschenden Lizenzeintrags.

Dokumentation der Properties:

  • long Count [get]

Count liefert die Anzahl der Elemente in der Collection zurück.

Parameter:

[out]: plNumber (VB-Rückgabewert) Anzahl der Elemente der Collection.

  • IFileParameter Item([in] VARIANT Index) [get]

Item liefert das angegebene Element der Collection anhand der Position oder des Schlüssels zurück.

Wird eine Position außerhalb des gültigen Index angegeben, wird ein Fehler mit dem Fehlerwert errCollectionIndexOutOfRange zurückgegeben. Kann das Item nicht gefunden werden, wird ein Fehler mit dem Wert errCollectionItemNotFound zurückgeliefert.

Parameter:

[in]: Index Position bzw. Name des angeforderten Elements.

[out]: ppItem (VB-Rückgabewert) zugehörofes FileParameter -Objekt.