Extract_CPIC_Side_Information (CPI-C)

La Extract_CPIC_Side_Information llamada (nombre de función xcmesi) devuelve la información lateral de un número de entrada o un nombre de destino simbólico.

Sintaxis

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

Parámetros

entry_number
Parámetro proporcionado. Especifica el número (índice) de la entrada de información lateral que se va a devolver. La primera entrada es 1.

En su lugar, el programa puede buscar la entrada de información lateral por el nombre de destino simbólico. Para ello, establezca el número de entrada en cero.

sym_dest_name
Parámetro proporcionado. Especifica el nombre de destino simbólico que se buscará.

Si entry_number se establece en un número mayor que cero, se omite este parámetro.

side_info_entry
Parámetro devuelto. Especifica la entrada de información lateral. Para obtener una explicación detallada de la entrada de información lateral, vea Set_CPIC_Side_Information.

Cada campo de la estructura de información lateral se alinea a la izquierda y se agrega con espacios a la derecha según sea necesario.

side_info_entry_length
Parámetro proporcionado. Siempre 124.

return_code
Código devuelto por esta llamada. Los códigos de retorno válidos se enumeran más adelante en este tema.

Códigos de retorno

CM_OK
Código de retorno principal; la llamada se ejecutó correctamente.

CM_PROGRAM_PARAMETER_CHECK
Código de retorno principal; se produjo una de las siguientes acciones:

  • El entry_number un número mayor que el número máximo de entradas de la tabla de información lateral o un número menor que cero.

  • El sym_dest_name parámetro no es válido y entry_number se establece en cero.

  • El side_info_entry_length parámetro no está establecido en 124.

    CM_PRODUCT_SPECIFIC_ERROR
    Código de retorno principal; Se produjo un error específico del producto y se registró en el registro de errores de productos.

Cambios de estado

Esta llamada no está asociada a una conversación y puede estar en cualquier estado.

No hay ningún cambio de estado.

Observaciones

La contraseña de seguridad nunca se devuelve. Si no se establece el identificador de usuario de seguridad en la información lateral, el campo identificador de usuario de seguridad se devuelve como todos los espacios.