Object Management Extension User Guide > Object Management Extension User Guide > Defining Function Instances > II_GET Operation--Get Next Segment
Was this helpful?
II_GET Operation--Get Next Segment
This operation gets the next segment of some object. The object is represented to II_GET by a coupon. This operation makes use of the saved information in the peripheral control block, which is passed in the pop_cb's user argument parameter.
Inputs
The input fields for the II_GET operation are the parts of the peripheral control block structure that tell the DBMS Server what and how to pass the information. The inputs are as follows:
op_code
The value of II_GET.
pop_cb
A pointer to the peripheral operations control block, II_POP_CB (for calling).
pop_continuation
Continuation indicator. On the first call II_C_BEGIN_MASK is passed; otherwise, zero (0) is passed.
pop_coupon
Pointer to II_DATA_VALUE, contains the coupon used to retrieve the object.
pop_segment
Pointer to II_DATA_VALUE to receive the output of II_GET. An error occurs if the size of the output is insufficient. For size determination, see II_INFORMATION Operation--Return Maximum Length of Peripheral Object Segments.
pop_user_arg
Server's internal state. This is set on the first call and must be presented unchanged for subsequent calls.
Outputs
The output fields for the II_GET operation describe the results the DBMS Server returns. The outputs are as follows:
pop_cb
A pointer to the peripheral operations control block, II_POP_CB (for calling).
pop_segment->db_data
The DBMS Server fills this field with the next segment.
pop_user_arg
The DBMS Server fills this field, if appropriate.
pop_error
The DBMS Server fills this field with the error value, if there is any.
Returns
II_STATUS
Last modified date: 08/28/2024