Cancel_Conversation (CPI-C)

Artikel
10/14/2023

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

Syntax

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

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 Produktfehlerprotokoll protokolliert.

Zustandsänderungen

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

Wenn der Rückgabecode CM_OK ist, wird der Konversationszustand zu RESET.

Hinweise

Cancel_Conversation kann aufgerufen werden, während ein anderer Vorgang für den angegebenen conversation_ID aktiv ist. Dadurch kann eine Anwendung jede CPI-C-Aktion beenden, die Konversation 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 einen Deallocate beendet, bei dem deallocate_type auf ABEND_SVC festgelegt ist. Es wird kein log_data gesendet. Das System kann dies möglicherweise nicht sofort tun, aber jede Verzögerung ist für das Programm transparent.

Hinweis

Wenn Cancel_Conversation aufgerufen wird, während Specify_Windows_Handle asynchronen Aufrufe ausstehen, werden diese Aufrufe abgebrochen. Die Rückgabecodes sind auf abgebrochen festgelegt, und eine Vervollständigungsmeldung wird veröffentlicht.

Freigeben über