Extract_CPIC_Side_Information (CPI-C)

Artikel
10/14/2023

Der Extract_CPIC_Side_Information-Aufruf (Funktionsname xcmesi) gibt die Seiteninformationen für eine Eintragsnummer oder einen symbolischen Zielnamen zurück.

Syntax

  
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            
);

Parameter

entry_number
Angegebener Parameter. Gibt die Anzahl (Index) des zurückzugebenden Seiteninformationseintrags an. Der erste Eintrag ist 1.

Das Programm kann stattdessen den Seiteninformationseintrag nach dem symbolischen Zielnamen suchen. Um dies zu erreichen, legen Sie die Eintragsnummer auf 0 (null) fest.

sym_dest_name
Angegebener Parameter. Gibt den symbolischen Zielnamen an, nach dem gesucht werden soll.

Wenn entry_number auf eine Zahl größer als 0 festgelegt ist, wird dieser Parameter ignoriert.

side_info_entry
Zurückgegebener Parameter. Gibt den Seiteninformationseintrag an. Eine ausführliche Erläuterung des Seiteninformationseintrags finden Sie unter Set_CPIC_Side_Information.

Jedes Feld in der seitenseitigen Informationsstruktur ist linksbündig ausgerichtet und nach Bedarf mit Leerzeichen auf der rechten Seite aufgefüllt.

side_info_entry_length
Angegebener Parameter. Immer 124.

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; eine der folgenden Ereignisse:

Die entry_number eine Zahl angegeben, die größer ist als die maximale Anzahl von Einträgen in der Seiteninformationstabelle oder eine Zahl, die kleiner als 0 (null) ist.
Der parameter sym_dest_name ist ungültig, und entry_number wird auf null festgelegt.
Der parameter side_info_entry_length ist nicht auf 124 festgelegt.

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

Zustandsänderungen

Dieser Aufruf ist keiner Unterhaltung zugeordnet und kann sich in einem beliebigen Zustand befinden.

Es gibt keine Zustandsänderung.

Hinweise

Das Sicherheitskennwort wird nie zurückgegeben. Wenn die Sicherheitsbenutzer-ID in den Seiteninformationen nicht festgelegt ist, wird das Feld "Sicherheitsbenutzer-ID" als alle Leerzeichen zurückgegeben.

Freigeben über