Function sapnwrfc::binding::RfcGetStringByIndex [−] [src]

pub unsafe extern "C" fn RfcGetStringByIndex(
    dataHandle: DATA_CONTAINER_HANDLE, 
    index: c_uint, 
    stringBuffer: *mut SAP_UC, 
    bufferLength: c_uint, 
    stringLength: *mut c_uint, 
    errorInfo: *mut RFC_ERROR_INFO
) -> RFC_RC

Returns the value of the specified field as null-terminated string.

This function works exactly like RfcGetString(), the difference being that the field is addressed by its index within the structure/table/function module. The first field has index 0, last field has index n-1, the order of the fields is as defined in the ABAP DDIC.

\in dataHandle A data container (function handle, structure handle or table handle). If dataHandle is a table handle, the function will read the field value of the current row. \in index The index of the field to read. \out *stringBuffer Pre-allocated buffer, which will receive the (converted) field value. \in bufferLength Size of the buffer in SAP_UC. \out *stringLength Always returns the string's length, no matter whether the stringBuffer had been large enough or not. (Note that if you want to try again after an RFC_BUFFER_TOO_SMALL, you need to make the stringBuffer at least *stringLength + 1 in order to account for the termnating null.) \out *errorInfo More information in case the field does not exist or a conversion fails. \return RFC_RC