Extract_CPIC_Side_Information (CPI-C)

Articolo
07/21/2023

La chiamata Extract_CPIC_Side_Information (nome funzione xcmesi) restituisce le informazioni sul lato per un numero di voce o un nome di destinazione simbolico.

Sintassi

  
CM_ENTRY Extract_CPIC_Side_Information(   
  CM_INT32 FAR *entry_number,          
  unsigned char FAR *sym_dest_name,    
  SIDE_INFO FAR *side_info_entry,      
  CM_INT32 FAR *side_info_entry_length,    
    CM_INT32 FAR *return_code            
);

Parametri

entry_number
Parametro fornito. Specifica il numero (indice) della voce delle informazioni sul lato da restituire. La prima voce è 1.

Il programma può cercare la voce delle informazioni laterali in base al nome della destinazione simbolica. A questo scopo, impostare il numero di voce su zero.

sym_dest_name
Parametro fornito. Specifica il nome della destinazione simbolica da cercare.

Se entry_number è impostato su un numero maggiore di zero, questo parametro viene ignorato.

side_info_entry
Parametro restituito. Specifica la voce delle informazioni sul lato. Per una spiegazione dettagliata della voce delle informazioni sul lato, vedere Set_CPIC_Side_Information.

Ogni campo nella struttura delle informazioni sul lato è allineato a sinistra e riempito con spazi a destra in base alle esigenze.

side_info_entry_length
Parametro fornito. Sempre 124.

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; si è verificato uno dei seguenti:

Il entry_number specificato un numero maggiore del numero massimo di voci nella tabella delle informazioni sul lato o un numero minore di zero.
Il parametro sym_dest_name non è valido e entry_number è impostato su zero.
Il parametro side_info_entry_length non è impostato su 124.

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

Questa chiamata non è associata a una conversazione e può essere in qualsiasi stato.

Non esiste alcuna modifica dello stato.

Commenti

La password di sicurezza non viene mai restituita. Se l'identificatore utente di sicurezza nelle informazioni sul lato non è impostato, il campo identificatore utente di sicurezza viene restituito come tutti gli spazi.

Condividi tramite