blpapi::Operation Class Reference

#include <blpapi_service.h>

List of all members.

Public Member Functions
	Operation (blpapi_Operation_t *handle)
	~Operation ()
const char *	name () const
const char *	description () const
SchemaElementDefinition	requestDefinition () const
int	numResponseDefinitions () const
SchemaElementDefinition	responseDefinition (size_t index) const
blpapi_Operation_t *	handle () const
bool	isValid () const

---

Detailed Description

Defines an operation which can be performed by a Service.

Operation objects are obtained from a Service object. They provide read-only access to the schema of the Operations Request and the schema of the possible response.

---

Constructor & Destructor Documentation

blpapi::Operation::Operation

(

blpapi_Operation_t *

handle

)

blpapi::Operation::~Operation

(

)

Destroy this Operation object.

---

Member Function Documentation

const char* blpapi::Operation::name

(

)

const

Returns a pointer to a null-terminated, read-only string which contains the name of this operation. The pointer remains valid until this Operation is destroyed.

const char* blpapi::Operation::description

(

)

const

Returns a pointer to a null-terminated, read-only string which contains a human readable description of this Operation. The pointer returned remains valid until this Operation is destroyed.

SchemaElementDefinition blpapi::Operation::requestDefinition

(

)

const

Returns a read-only SchemaElementDefinition which defines the schema for this Operation.

int blpapi::Operation::numResponseDefinitions

(

)

const

Returns the number of the response types that can be returned by this Operation.

SchemaElementDefinition blpapi::Operation::responseDefinition

(

size_t

index

)

const

Returns a read-only SchemaElementDefinition which defines the schema for the response that this Operation delivers.

blpapi_Operation_t* blpapi::Operation::handle

(

)

const

bool blpapi::Operation::isValid

(

)

const

TBD - no default ctor so no need for this?

---

The documentation for this class was generated from the following file:

• blpapi_service.h