Cancel_Conversation (CPI-C)

La chiamata Cancel_Conversation (nome funzione cmcanc) annulla qualsiasi operazione in sospeso in una conversazione (un'operazione restituita con CM_OPERATION_INCOMPLETE) e la conversazione stessa.

Sintassi

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

Parametri

conversation_ID
Parametro restituito. Specifica l'identificatore per la conversazione. Il valore di questo parametro è stato restituito da Initialize_Conversation o Accept_Conversation.

return_code
Codice restituito da questa chiamata. I codici restituiti validi sono elencati più avanti in questo argomento.

Codici restituiti

CM_OK
Codice restituito primario; la chiamata eseguita correttamente.

CM_PROGRAM_PARAMETER_CHECK
Codice restituito primario; il valore specificato da conversation_ID non è valido.

CM_PRODUCT_SPECIFIC_ERROR
Codice restituito primario; si è verificato un errore specifico del prodotto ed è stato registrato nel log degli errori dei prodotti.

Modifiche di stato

La conversazione deve trovarsi in qualsiasi stato tranne RESET.

Quando il codice restituito è CM_OK, lo stato della conversazione diventa RESET.

Commenti

Cancel_Conversation può essere chiamato mentre un'altra operazione è attiva per il conversation_ID specificato. Ciò consente a un'applicazione di terminare qualsiasi azione CPI-C, ma termina la conversazione. Questa chiamata può essere emessa indipendentemente dalla modalità di elaborazione dell'applicazione corrente. Tutte le operazioni in sospeso restituiranno con CM_DEALLOCATED_ABEND come codice restituito.

La conversazione viene terminata da deallocate con deallocate_type impostata su ABEND_SVC . Non viene inviato alcun log_data . Il sistema potrebbe non essere in grado di farlo immediatamente, ma qualsiasi ritardo è trasparente per il programma.

Nota

Se Cancel_Conversation viene chiamato mentre sono presenti chiamate asincrone Specify_Windows_Handle in sospeso, queste chiamate vengono annullate. I codici restituiti sono impostati su annullati e viene pubblicato un messaggio di completamento.