OFReturnBmipResponse(S_ADM)

Syntax

#include <scoAdmin/osaStdDef.h>

void OFReturnBmipResponse(errStatusPtr, handleId, bmipResponsePtr, continueFlag)

Description

Arguments

errStatus_cl *errStatusPtr

A pointer to the error stack data structure. If an error occurs in retrieving the data, the appropriate error will be placed in the error stack. This data can be referenced using the library functions associated with the error stack.

int handleId

This is the handle with which the Server API stores extra information about the current BMIP request. This is passed to the request processor, or it can be generated with the OFGenerateHandleId() function.

bmipResponse_pt bmipResponsePtr

This is the BMIP response structure forwarded by the ofEvaluateOperation routine. A pointer to the structure representing the current BMIP response.

bool_t continueFlag

This is set to TRUE only if this request to the OFReturnBmipResponse is not the last one associated with the given sessionId. If there is only one response, or the last response is to be forwarded to these routines, then this flag should be set to FALSE.

Error messages

NO_SUCH_CLASS_HANDLE

The handleId named does not correspond to an existing class in the Server APIs internal lookup table.

Example

void
ObjectRequestProcessor(errStatus_cl       *errStatusPtr,
                       int                 handleId,
                       bmipRequest_pt      bmipRequestPtr,
                       void               *osaDataPtr)
   {
        .
        .
        .
       
        bmipResponse_t *bmipResponsePtr;
        bmipResponsePtr = OFEvaluateOperation(errStatusPtr,
                                              handleId,
                                              bmipRequestPtr->objectInstance);
       
        OFReturnBmipResponse(errStatusPtr,
                             handleId,
                             bmipResponsePtr,
                             FALSE);

See also