VMS Help  —  DCE  DCE_RPC, Application Routines, idl_es_inq_encoding_id
 NAME

   idl_es_inq_encoding_id - Identifies an operation within an interface
                            that has been called to encode data using
                            the IDL encoding services

 SYNOPSIS

   void idl_es_inq_encoding_id( idl_es_handle_t  es_handle,
                                rpc_if_id_t *if_id,
                                idl_ulong_int  *op_num,
                                error_status_t  *status );

 PARAMETERS

   Input

   es_handle
        A encoding services handle returned by one of the IDL encoding
        services handle-returning routines.

   Output

   if_id
        Returns the interface UUID and version number assigned to the
        interface that defines the operation that encoded the data.
        This information is stored in the IDL encoding services handle
        that is associated with the encoded data.

   op_num
        Returns the operation number assigned to the operation that
        encoded the data. Operations are numbered in the order in
        which they appear in the interface definition, starting with
        zero (0). The operation number for the operation that encoded
        the data is stored in the IDL encoding services handle that
        is associated with the encoded data.

   status
        Returns the status code from this routine. This status code
        indicates whether the routine completed successfully or, if
        not, why not.  The possible status codes and their meanings
        are as follows:

        rpc_s_ok       Success.

        rpc_s_unknown_if
                       Interface identifier and operation number
                       unavailable.

 DESCRIPTION

   The IDL encoding services provide client and server RPC applications
   with a method for encoding data types in input parameters into a byte
   stream and decoding data types in output parameters from a byte
   stream without invoking the RPC runtime.  Encoding and decoding
   operations are analogous to marshalling and unmarshalling, except
   that the data is stored locally, and is not transmitted over the
   network.  Client and server applications can use the IDL encoding
   services to create persistent storage for their data.  Encoding
   "flattens" complex data types into a byte stream for storage on
   disk, while decoding restores the flattened data to complex form.

   The idl_es_inq_encoding_id() routine returns the identity of an
   operation within an application that has been invoked to encode data
   using the IDL encoding services. Applications can use this routine
   to determine the identity of an encoding operation, for example,
   before calling their decoding operations.

 RETURN VALUES

   None.

 RELATED INFORMATION

   Functions: idl_es_decode_buffer
              idl_es_decode_incremental
              idl_es_encode_dyn_buffer
              idl_es_encode_fixed_buffer
              idl_es_encode_incremental
Close Help