Set_Return_Control (CPI-C)

Articolo
10/14/2023

La chiamata Set_Return_Control (nome funzione cmsrc) viene emessa dal programma di chiamata per specificare quando l'unità logica locale (LU), che agisce sulla richiesta di sessione dalla chiamata Allocata programmi locali, deve restituire il controllo al programma locale.

Sintassi

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

Parametri

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

return_control
Parametro fornito. Specifica quando l'lu locale, che agisce sulla chiamata Allocato , deve restituire il controllo al programma locale. I valori seguenti sono consentiti:

CM_IMMEDIATE
L'LU alloca una sessione vincitore di contesa, se ne è immediatamente disponibile e restituisce il controllo al programma.

CM_WHEN_SESSION_ALLOCATED
L'lu non restituisce il controllo al programma finché non alloca una sessione o rileva errori. Se una sessione non è disponibile, il programma attende uno. Se il limite di sessione è zero, l'lu restituisce immediatamente il controllo.

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_STATE_CHECK
Codice restituito primario; la conversazione non è in stato INITIALIZE.

CM_PROGRAM_PARAMETER_CHECK
Codice restituito primario; il valore specificato da conversation_ID o return_control 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 essere in stato INITIALIZE.

Non esiste alcuna modifica dello stato.

Commenti

Questa chiamata esegue l'override del controllo restituito predefinito stabilito da Initialize_Conversation. Per impostazione predefinita, il controllo viene restituito quando viene allocata la sessione. Questa chiamata non può essere emessa dopo l'emissione della chiamata Allocata .

Per altre informazioni sulle sessioni, vedere Scrittura di applicazioni CPI-C.

Se l'lu non è in grado di allocare una sessione, la notifica viene restituita nella chiamata Allocato .

Condividi tramite