Click or drag to resize
Request Interface
This class represents a single request to a particular service.

Namespace:  Bloomberglp.Blpapi
Assembly:  Bloomberglp.Blpapi (in Bloomberglp.Blpapi.dll) Version: 3.12.5.1
Syntax
public interface Request

The Request type exposes the following members.

Properties
  NameDescription
Public propertyAsElement
Gets the contents of this Request as an element.
Public propertyElements
Gets the enumerable collection of all elements in this request.
Public propertyItemString
This is the same as GetElement(name)
Public propertyItemName
This is the same as GetElement(name)
Public propertyOperation
Gets the Operation this Request is intended to invoke on the associated Service.
Top
Methods
  NameDescription
Public methodAppend(String, Constant)
Appends the specified value to the named array element of this request.
Public methodAppend(String, Datetime)
Appends the specified value to the named array element of this request.
Public methodAppend(String, Name)
Appends the specified value to the named array element of this request.
Public methodAppend(String, Boolean)
Appends the specified value to the named array element of this request.
Public methodAppend(String, Byte)
Appends the specified value to the named array element of this request.
Public methodAppend(String, Char)
Appends the specified value to the named array element of this request.
Public methodAppend(String, Double)
Appends the specified value to the named array element of this request.
Public methodAppend(String, Int32)
Appends the specified value to the named array element of this request.
Public methodAppend(String, Int64)
Appends the specified value to the named array element of this request.
Public methodAppend(String, Single)
Appends the specified value to the named array element of this request.
Public methodAppend(String, String)
Appends the specified value to the named array element of this request.
Public methodAppend(Name, Constant)
Appends the specified value to the named array element of this request.
Public methodAppend(Name, Datetime)
Appends the specified value to the named array element of this request.
Public methodAppend(Name, Name)
Appends the specified value to the named array element of this request.
Public methodAppend(Name, Boolean)
Appends the specified value to the named array element of this request.
Public methodAppend(Name, Byte)
Appends the specified value to the named array element of this request.
Public methodAppend(Name, Char)
Appends the specified value to the named array element of this request.
Public methodAppend(Name, Double)
Appends the specified value to the named array element of this request.
Public methodAppend(Name, Int32)
Appends the specified value to the named array element of this request.
Public methodAppend(Name, Int64)
Appends the specified value to the named array element of this request.
Public methodAppend(Name, Single)
Appends the specified value to the named array element of this request.
Public methodAppend(Name, String)
Appends the specified value to the named array element of this request.
Public methodGetElement(String)
Returns the modifiable element of this request having the specified name creating it if doesn't exist already.
Public methodGetElement(Name)
Returns the modifiable element of this request having the specified name creating it if doesn't exist already.
Public methodHasElement(String)
Returns true if this request contains the element having the specified name false otherwise.
Public methodHasElement(Name)
Returns true if this request contains the element having the specified name false otherwise.
Public methodPrint(Stream)
Prints the contents of this message to the specified Stream.
Public methodPrint(TextWriter)
Prints the contents of this message to the specified TextWriter.
Public methodSet(String, Constant)
Sets the element of this request having the specified name to the specified value.
Public methodSet(String, Datetime)
Sets the element of this request having the specified name to the specified value.
Public methodSet(String, Name)
Sets the element of this request having the specified name to the specified value.
Public methodSet(String, Boolean)
Sets the element of this request having the specified name to the specified value.
Public methodSet(String, Byte)
Sets the element of this request having the specified name to the specified value.
Public methodSet(String, Char)
Sets the element of this request having the specified name to the specified value.
Public methodSet(String, Double)
Sets the element of this request having the specified name to the specified value.
Public methodSet(String, Int32)
Sets the element of this request having the specified name to the specified value.
Public methodSet(String, Int64)
Sets the element of this request having the specified name to the specified value.
Public methodSet(String, Single)
Sets the element of this request having the specified name to the specified value.
Public methodSet(String, String)
Sets the element of this request having the specified name to the specified value.
Public methodSet(Name, Constant)
Sets the element of this request having the specified name to the specified value.
Public methodSet(Name, Datetime)
Sets the element of this request having the specified name to the specified value.
Public methodSet(Name, Name)
Sets the element of this request having the specified name to the specified value.
Public methodSet(Name, Boolean)
Sets the element of this request having the specified name to the specified value.
Public methodSet(Name, Byte)
Sets the element of this request having the specified name to the specified value.
Public methodSet(Name, Char)
Sets the element of this request having the specified name to the specified value.
Public methodSet(Name, Double)
Sets the element of this request having the specified name to the specified value.
Public methodSet(Name, Int32)
Sets the element of this request having the specified name to the specified value.
Public methodSet(Name, Int64)
Sets the element of this request having the specified name to the specified value.
Public methodSet(Name, Single)
Sets the element of this request having the specified name to the specified value.
Public methodSet(Name, String)
Sets the element of this request having the specified name to the specified value.
Top
Remarks

Request objects are created using Service.CreateRequest(string) or Service.CreateAuthorizationRequest(). They are used with Session.SendRequest(Request, UserHandle, EventQueue, CorrelationID, String) or Session.SendAuthorizationRequest(Request, UserHandle, EventQueue, CorrelationID, String). The Request object contains the parameters for a single request to a single service. Once a Request has been created its fields can be populated directly using the convenience functions set() and append() or using the Element interface on the Element returned by AsElement.

The schema for the Request can be queried using the Element interface on the Element returned by AsElement.

Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also