Set_Partner_Index - Index der Partner-Anwendung setzen

Der Aufruf Set_Partner_Index (CMSPIN) setzt den Index für die anschließende Set_Partner_xxx-Aufrufe der Partner-Anwendung der Conversation. Er darf nach dem Aufruf Allocate nicht mehr aufgerufen werden. Set_Partner_xxx-Aufrufe ohne einen vorangegangenen Set_Partner_Index-Aufruf werden wie nach einem Set_Partner_Index-Aufruf mit Index 1 behandelt.

Diese Funktion gehört zu den zusätzlichen Funktionen des Trägersystems UPIC; sie ist nicht Bestandteil der CPI-C-Schnittstelle.

UPIC-Local auf Unix-, Linux- und Windows-Systemen:

Der Aufruf Set_Partner_Index wird bei der Anbindung über UPIC-L nicht unterstützt.

Syntax

CMSPIN (conversation_ID, partner_index, return_code)

Parameter

--> conversation_ID	Identifikation der Conversation
--> partner_index	legt fest, auf welchen partner_index sich die folgenden Set_Partner_xxx-Aufrufe beziehen. Minimum: 1 (Standardwert-Wert); die Folge der partner_index-Werte darf keine Lücken aufweisen.
<-- return_code	Ergebnis des Funktionsaufrufs

Ergebnis (return_code)

CM_OK

Aufruf ok

CM_CALL_NOT_SUPPORTED

Dieser Returncode gilt nur für Unix-, Linux- und Windows-Systeme.
Die Funktion wird nicht unterstützt.

Bei UPIC-L tritt der Returncode immer auf.

Bei UPIC-R tritt der Returncode nur auf, wenn ein openUTM-Cluster konfiguriert wurde.

CM_PROGRAM_PARAMETER_CHECK

Der Wert der conversation_ID oder für partner_index ist ungültig (Die partner-index-Werte dürfen keine Lücken aufweisen).

CM_PROGRAM_STATE_CHECK

Die Conversation ist nicht im Zustand "Initialize".

CM_PRODUCT_SPECIFIC_ERROR

Die UPIC-Instanz konnte nicht gefunden werden oder Speicherengpass.

Zustandsänderung

Der Aufruf ändert den Zustand der Conversation nicht.

Verhalten im Fehlerfall

CM_CALL_NOT_SUPPORTED

Normales Verhalten falls

• die Anwendung mit einer UPIC-L-Bibliothek gebunden ist (auf Unix-, Linux- und Windows-Systemen)

• oder ein openUTM-Cluster konfiguriert wurde.

In diesem Fall steht diese Funktionalität nicht zur Verfügung.

CM_PROGRAM_PARAMETER_CHECK

Programm ändern.

CM_PROGRAM_STATE_CHECK

Programm ändern.

CM_PRODUCT_SPECIFIC_ERROR

Das Betriebssystem kann nicht genügend Speicherplatz für interne Puffer bereitstellen. Überprüfen Sie Ihr Programm auf zu hohe Speicherplatzanforderung und starten Sie ggf. Ihr System neu.

Funktionsdeklaration: Set_Partner_Index

CM_ENTRY Set_Partner_Index( unsigned char  CM_PTR  conversation_ID,
                            CM_INT32       CM_PTR  partner_index,
                            CM_RETURN_CODE CM_PTR  return_code )