Cancel_Conversation (CPI-C)

Der Cancel_Conversation Aufruf (Funktionsname cmcanc) bricht alle ausstehenden Vorgänge für eine Unterhaltung (ein mit CM_OPERATION_INCOMPLETE zurückgegebener Vorgang) und die Unterhaltung selbst ab.

Syntax

  
CM_ENTRY Cancel_Conversation(   
  unsigned char FAR *conversation_ID,    
    CM_INT32 FAR *return_code              
);  

Die Parameter

conversation_ID
Zurückgegebener Parameter. Gibt den Bezeichner für die Unterhaltung an. Der Wert dieses Parameters wurde von Initialize_Conversation oder Accept_Conversation zurückgegeben.

return_code
Der von diesem Aufruf zurückgegebene Code. Die gültigen Rückgabecodes werden weiter unten in diesem Thema aufgeführt.

Rückgabecodes

CM_OK
Primärer Rückgabecode; Der Aufruf wurde erfolgreich ausgeführt.

CM_PROGRAM_PARAMETER_CHECK
Primärer Rückgabecode; Der durch conversation_ID angegebene Wert ist ungültig.

CM_PRODUCT_SPECIFIC_ERROR
Primärer Rückgabecode; Ein produktspezifischer Fehler ist aufgetreten und wurde im Fehlerprotokoll der Produkte protokolliert.

Statusänderungen

Die Unterhaltung muss sich in einem beliebigen Zustand befinden, mit Ausnahme von RESET.

Wenn der Rückgabecode CM_OK ist, wird der Unterhaltungszustand ZURÜCKGESETZT.

Bemerkungen

Cancel_Conversation kann aufgerufen werden, während ein anderer Vorgang für die angegebene conversation_ID aktiv ist. Dadurch kann eine Anwendung jede CPI-C Aktion beenden, die Unterhaltung wird jedoch beendet. Dieser Aufruf kann unabhängig vom aktuellen Anwendungsverarbeitungsmodus ausgegeben werden. Alle ausstehenden Vorgänge werden mit CM_DEALLOCATED_ABEND als Rückgabecode zurückgegeben.

Die Unterhaltung wird durch eine Deallocate beendet, wobei deallocate_type auf ABEND_SVC festgelegt ist. Es wird keine log_data gesendet. Das System kann dies möglicherweise nicht sofort tun, aber jede Verzögerung ist für das Programm transparent.