#include <blpapi_service.h>

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

SchemaElementDefinition	responseDefinition (const Name &name) 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.

See Component blpapi_service

Constructor & Destructor Documentation

◆ Operation()

Operation ( blpapi_Operation_t * handle )

explicit

◆ ~Operation()

~Operation ( )

Destroy this Operation object.

Member Function Documentation

◆ description()

const char * 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.

◆ handle()

blpapi_Operation_t * handle ( ) const

Returns handle to the underlying implementation.

◆ isValid()

bool isValid ( ) const

Returns true if this Operation is valid. That is, it was returned from a Service.

◆ name()

const char * 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.

◆ numResponseDefinitions()

int numResponseDefinitions ( ) const

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

◆ requestDefinition()

SchemaElementDefinition requestDefinition ( ) const

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

◆ responseDefinition() [1/2]

SchemaElementDefinition responseDefinition ( size_t index ) const

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

◆ responseDefinition() [2/2]

SchemaElementDefinition responseDefinition ( const Name & name ) const

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

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

blpapi_service.h

Public Member Functions