IInputParameters

Beschreibung:

IInputParameters ist eine Collection für die Erstellung und Verwaltung der InputParameter eines Jobs .

import "OxSvrSpt.idl"

Öffentliche Methoden:

HRESULT AddNewStringParameter ([in] BSTR Name, [in] BSTR Value, [out,
retval] IParameter ** ppVal)
HRESULT AddNewIntegerParameter ([in] BSTR Name, [in] long Value, [out,
retval] IParameter ** ppVal)
HRESULT AddNewBooleanParameter ([in] BSTR Name, [in] VARIANT_BOOL Value,
[out, retval] IParameter ** ppVal)
HRESULT AddNewDoubleParameter ([in] BSTR Name, [in] double Value, [out,
retval] IParameter ** ppVal)
HRESULT AddNewDatetimeParameter ([in] BSTR Name, [in] DATE Value, [out,
retval] IParameter ** ppVal)
HRESULT AddNewXMLParameter ([in] BSTR Name, [in, defaultvalue("")] BSTR
XML, [out, retval] IParameter ** ppVal)
HRESULT AddNewByteParameter ([in] BSTR Name, [in, optional] VARIANT
Value, [out, retval] IParameter ** ppVal)
HRESULT AddParameter ([in] IParameter * Parameter)
HRESULT Remove ([in] VARIANT Index, [out, retval] IParameter ** ppVal)
HRESULT Clear ()

Properties:

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

Dokumentation der Elementfunktionen:

  • HRESULT AddNewBooleanParameter ([in] BSTR Name, [in] VARIANT_BOOL Value, [out, retval] IParameter ** ppVal)

AddNewBooleanParameter erzeugt einen neuen Boolean-Parameter, fügt diesen zur Collection hinzu und liefert ihn zurück. Der Name des Parameters darf keine leere Zeichenkette sein, ansonsten wird ein Fehler zurückgeliefert. Wird versucht, einen Parameter mit einem Namen hinzuzufügen, der bereits existiert, wird ein Fehler ausgelöst.

Parameter:

[in]: Name Name des Parameters .

[in]: Value Initialisierungswert des Parameters.

[out]: ppVal (VB-Rückgabeparameter) erzeugtes und initialisiertes Parameterobjekt.

Ausnahmebehandlung:

errInputParametersCantCreate (1101) Der Parameter konnte nicht erzeugt werden. Es stehen in diesem Fall keine weiterenn Informationen zur Verfügung.

errParameterNameEmpty (1201) Es wurde kein Name für den Parameter angegeben.

errParameterDoubleName (1202) Es existiert bereits ein Parameter mit dem angegebenen Namen.

  • HRESULT AddNewByteParameter ([in] BSTR Name, [in, optional] VARIANT Value, [out, retval] IParameter ** ppVal)

AddNewByteParameter erzeugt einen neuen Byte-Parameter, fügt diesen zur Collection hinzu und liefert ihn zurück. Der Name des Parameters darf keine leere Zeichenkette sein, ansonsten wird ein Fehler zurückgeliefert. Wird versucht, einen Parameter mit einem Namen hinzuzufügen, der bereits existiert, wird ein Fehler ausgelöst.

Der Wert kann bei der Initialisierung als Zeichenkette übergeben werden bzw. nachträglich über die AppendChunk bzw. die Stream -Funktionen hinzugefügt werden. Wenn der Wert für Value später initialisert werden soll, muss ein Variant vom Typ VT_NULL oder VT_ERROR übergeben werden.

Unter VB und VB-Script braucht der Value -Parameter der Methode nicht angegeben zu werden, wenn die Binär-Daten zu einem späteren Zeitpunkt dem Parameterobjekt hinzugefügt werden sollen.

Parameter:

[in]: Name Name des Parameters .

[in]: Value Initialisierungswert des Parameters.

[out]: ppVal (VB-Rückgabeparameter) erzeugtes und initialisiertes Parameterobjekt.

Ausnahmebehandlung:

errInputParametersCantCreate (1101) Der Parameter konnte nicht erzeugt werden. Es stehen in diesem Fall keine weiterenn Informationen zur Verfügung.

errParameterNameEmpty (1201) Es wurde kein Name für den Parameter angegeben.

errParameterDoubleName (1202) Es existiert bereits ein Parameter mit dem angegebenen Namen.

Beispiel:

Dim oParameter As OxSvrSpt.Parameter
Set oParameter = m_oInputParameters.AddNewByteParameter(strName)

  • HRESULT AddNewDatetimeParameter ([in] BSTR Name, [in] DATE Value, [out, retval] IParameter ** ppVal)

AddNewDatetimeParameter erzeugt einen neuen Double-Parameter, fügt diesen zur Collection hinzu und liefert ihn zurück. Der Name des Parameters darf keine leere Zeichenkette sein, ansonsten wird ein Fehler zurückgeliefert. Wird versucht, einen Parameter mit einem Namen hinzuzufügen, der bereits existiert, wird ein Fehler ausgelöst. VT_8

Parameter:

[in]: Name Name des Parameters .

[in]: Value Initialisierungswert des Parameters.

[out]: ppVal (VB-Rückgabeparameter) erzeugtes und initialisiertes Parameterobjekt.

Ausnahmebehandlung:

errInputParametersCantCreate (1101) Der Parameter konnte nicht erzeugt werden. Es stehen in diesem Fall keine weiterenn Informationen zur Verfügung.

errParameterNameEmpty (1201) Es wurde kein Name für den Parameter angegeben.

errParameterDoubleName (1202) Es existiert bereits ein Parameter mit dem angegebenen Namen.

  • HRESULT AddNewDoubleParameter ([in] BSTR Name, [in] double Value, [out, retval] IParameter ** ppVal)

AddNewDoubleParameter erzeugt einen neuen Double-Parameter, fügt diesen zur Collection hinzu und liefert ihn zurück. Der Name des Parameters darf keine leere Zeichenkette sein, ansonsten wird ein Fehler zurückgeliefert. Wird versucht, einen Parameter mit einem Namen hinzuzufügen, der bereits existiert, wird ein Fehler ausgelöst. VT_8

Parameter:

[in]: Name Name des Parameters .

[in]: Value Initialisierungswert des Parameters.

[out]: ppVal (VB-Rückgabeparameter) erzeugtes und initialisiertes Parameterobjekt.

Ausnahmebehandlung:

errInputParametersCantCreate (1101) Der Parameter konnte nicht erzeugt werden. Es stehen in diesem Fall keine weiterenn Informationen zur Verfügung.

errParameterNameEmpty (1201) Es wurde kein Name für den Parameter angegeben.

errParameterDoubleName (1202) Es existiert bereits ein Parameter mit dem angegebenen Namen.

  • HRESULT AddNewIntegerParameter ([in] BSTR Name, [in] long Value, [out, retval] IParameter ** ppVal)

AddNewIntegerParameter erzeugt einen neuen Integer-Parameter, fügt diesen zur Collection hinzu und liefert ihn zurück.

Der Name des Parameters darf keine leere Zeichenkette sein, ansonsten wird ein Fehler zurückgeliefert. Wird versucht, einen Parameter mit einem Namen hinzuzufügen, der bereits existiert, wird ein Fehler ausgelöst. VT_I4

Parameter:

[in]: Name Name des Parameters .

[in]: Value Initialisierungswert des Parameters.

[out]: ppVal (VB-Rückgabeparameter) erzeugtes und initialisiertes Parameterobjekt.

Ausnahmebehandlung:

errInputParametersCantCreate (1101) Der Parameter konnte nicht erzeugt werden. Es stehen in diesem Fall keine weiterenn Informationen zur Verfügung.

errParameterNameEmpty (1201) Es wurde kein Name für den Parameter angegeben.

errParameterDoubleName (1202) Es existiert bereits ein Parameter mit dem angegebenen Namen.

  • HRESULT AddNewStringParameter ([in] BSTR Name, [in] BSTR Value, [out, retval] IParameter ** ppVal)

AddNewStringParameter erzeugt einen neuen String-Parameter, fügt diesen zur Collection hinzu und liefert ihn zurück.

Der Name des Parameters darf keine leere Zeichenkette sein, ansonsten wird ein Fehler zurückgeliefert. Wird versucht, einen Parameter mit einem Namen hinzuzufügen, der bereits existiert, wird ein Fehler ausgelöst.

Parameter:

[in]: Name Name des Parameters .

[in]: Value Initialisierungswert des Parameters.

[out]: ppVal (VB-Rückgabeparameter) erzeugtes und initialisiertes Parameterobjekt.

Ausnahmebehandlung:

errInputParametersCantCreate (1101) Der Parameter konnte nicht erzeugt werden. Es stehen in diesem Fall keine weiterenn Informationen zur Verfügung.

errParameterNameEmpty (1201) Es wurde kein Name für den Parameter angegeben.

errParameterDoubleName (1202) Es existiert bereits ein Parameter mit dem angegebenen Namen.

Beispiel:

C++

try
{
    IInputParametersPtr spParameters( spJob->InputParameters );
    _bstr_t bstrParameterName( L"Name" );
    _bstr_t bstrParameterValue( L"Wert" );
    spParameters->AddNewStringParameter( bstrParameterName, bstrParameterValue );
}
catch( _com_error& e )
{
    // Fehlerbeschreibung ermitteln
    _bstr_t bstrError = e.Description( );
    // wenn keine Fehlerbeschreibung vom COM-Fehlerobjekt mitgeliefert wurde ...
    if( bstrError.length() == 0 )
    {
        // ... die Fehlermeldung des Systems ermitteln
        bstrError = e.ErrorMessage();
    }
    // TODO: bstrError enthält die Fehlerbeschreibung zur weiteren Verarbeitung.
}

  • HRESULT AddNewXMLParameter ([in] BSTR Name, [in, defaultvalue("")] BSTR XML, [out, retval] IParameter ** ppVal)

AddNewXMLParameter erzeugt einen neuen XML-Parameter, fügt diesen zur Collection hinzu und liefert ihn zurück. Der Name des Parameters darf keine leere Zeichenkette sein, ansonsten wird ein Fehler zurückgeliefert. Wird versucht, einen Parameter mit einem Namen hinzuzufügen, der bereits existiert, wird ein Fehler ausgelöst.

Der Wert kann bei der Initialisierung als Zeichenkette übergeben werden bzw. nachträglich über die AppendChunk bzw. die Stream -Funktionen hinzugefügt werden.

Unter VB und VB-Script braucht der XML-Parameter der Methode nicht angegeben zu werden, wenn die XML-Daten zu einem späteren Zeitpunkt dem Parameterobjekt hinzugefügt werden sollen.

Parameter:

[in]: Name Name des Parameters .

[in]: XML Initialisierungswert des Parameters.

[out]: ppVal (VB-Rückgabeparameter) erzeugtes und initialisiertes Parameterobjekt.

Ausnahmebehandlung:

errInputParametersCantCreate (1101) Der Parameter konnte nicht erzeugt werden. Es stehen in diesem Fall keine weiterenn Informationen zur Verfügung.

errParameterNameEmpty (1201) Es wurde kein Name für den Parameter angegeben.

errParameterDoubleName (1202) Es existiert bereits ein Parameter mit dem angegebenen Namen.

Beispiel:

Dim oParameter As OxSvrSpt.Parameter
Set oParameter = m_oInputParameters.AddNewXMLParameter(strName)

  • HRESULT AddParameter ([in] IParameter * Parameter)

AddParameter fügt den übergebenen Parameter in die Collection ein.

Es ist durch diese Methode möglich Parameter von anderen Aufrufen ohne Kopie weiterzureichen.

Parameter:

[in]: Parameter hinzuzufügender Parameter .

Ausnahmebehandlung:

errInputParametersCantCreate (1101) Der Parameter konnte nicht erzeugt werden. Es stehen in diesem Fall keine weiterenn Informationen zur Verfügung.

errParameterNameEmpty (1201) Es wurde kein Name für den Parameter angegeben.

errParameterDoubleName (1202) Es existiert bereits ein Parameter mit dem angegebenen Namen.

Beispiel:

Dim oParameter As OxSvrSpt.Parameter
...
' Parameter in anderem Job (-aufruf) füllen
...
m_oInputParameters.AddParameter(oParameter)

  • HRESULT Clear ()

Clear entfernt alle Elemente der Collection.

  • HRESULT Remove ([in] VARIANT Index, [out, retval] IParameter ** ppVal)

abn.Remove entfernt den Eintrag mit dem übergebenen Bezeichner aus der Parameterliste und liefert diesen zurück.

Wird der angegebene Eintrag nicht gefunden, wird ein Fehler zurückgeliefert.

Parameter:

[in]: Index Name oder Position des Eintrags, der aus der Parametercollection entfernt werden soll. Wird der Index -Parameter als Integer oder Long übergeben, wird nach dem Item an der entsprechenden Position gesucht. In C++ ist in diesem Fall ein Variant vom Typ VT_12 oder VT_14 zu übergeben. Wird der Index -Parameter als Zeichenkette (VT_BSTR) übergeben, wird nach dem Namen des Items gesucht.

[out]: ppVal (VB-Rückgabeparameter) liefert das entfernte Parameterobjekt zurück .

Ausnahmebehandlung:

errCollectionItemNotFound (1304) Der angeforderte Eintrag wurde nicht gefunden.

errCollectionIndexOutOfRange (1303) Der angeforderte Index befindet sich außerhalb des Bereichs.

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

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

Item liefert 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 zugehöriges Parameter-Objekt