| Request Interface |
This class represents a single request to a particular service.
Namespace: Bloomberglp.Blpapi
Assembly: Bloomberglp.Blpapi (in Bloomberglp.Blpapi.dll) Version: 3.22.0.1
SyntaxThe Request type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AsElement |
Gets the contents of this Request as an element.
|
| Elements |
Gets the enumerable collection of all elements in this request.
|
| ItemString |
This is the same as GetElement(name) |
| ItemName |
This is the same as GetElement(name) |
| Operation |
Gets the Operation this Request is intended to invoke on the
associated Service.
|
| RequestId |
Returns request id if one exists, otherwise, null.
If there are issues with this request, the request id can be reported to Bloomberg for troubleshooting purposes. Note that request id is not the same as correlation id and should not be used for correlation purposes. |
Methods| Name | Description | |
|---|---|---|
 | Append(String, Constant) | Obsolete. Appends the specified value to the named array element of this request.
Deprecated, use Append(Name, Constant) instead.
|
| Append(String, Datetime) | Obsolete. Appends the specified value to the named array element of this request.
Deprecated, use Append(Name, Datetime) instead.
|
| Append(String, Name) | Obsolete. Appends the specified value to the named array element of this request.
Deprecated, use Append(Name, Name) instead.
|
| Append(String, Boolean) | Obsolete. Appends the specified value to the named array element of this request.
Deprecated, use Append(Name, Boolean) instead.
|
| Append(String, Byte) | Obsolete. Appends the specified value to the named array element of this request.
Deprecated. Arrays of byte arrays are not supported.
This method will always throw an NotSupportedException.
|
| Append(String, Char) | Obsolete. Appends the specified value to the named array element of this request.
Deprecated, use Append(Name, Char) instead.
|
| Append(String, Double) | Obsolete. Appends the specified value to the named array element of this request.
Deprecated, use Append(Name, Double) instead.
|
| Append(String, Int32) | Obsolete. Appends the specified value to the named array element of this request.
Deprecated, use Append(Name, Int32) instead.
|
| Append(String, Int64) | Obsolete. Appends the specified value to the named array element of this request.
Deprecated, use Append(Name, Int64) instead.
|
| Append(String, Single) | Obsolete. Appends the specified value to the named array element of this request.
Deprecated, use Append(Name, Single) instead.
|
| Append(String, String) | Obsolete. Appends the specified value to the named array element of this request.
Deprecated, use Append(Name, String) instead.
|
| Append(Name, Constant) | Appends the specified value to the named array element of this request.
|
| Append(Name, Datetime) | Appends the specified value to the named array element of this request.
|
| Append(Name, Name) | Appends the specified value to the named array element of this request.
|
| Append(Name, Boolean) | Appends the specified value to the named array element of this request.
|
| Append(Name, Byte) | Obsolete. Appends the specified value to the named array element of this request.
Deprecated. Arrays of byte arrays are not supported. This method will always throw an NotSupportedException.
|
| Append(Name, Char) | Appends the specified value to the named array element of this request.
|
| Append(Name, Double) | Appends the specified value to the named array element of this request.
|
| Append(Name, Int32) | Appends the specified value to the named array element of this request.
|
| Append(Name, Int64) | Appends the specified value to the named array element of this request.
|
| Append(Name, Single) | Appends the specified value to the named array element of this request.
|
| Append(Name, String) | Appends the specified value to the named array element of this request.
|
| GetElement(String) | Obsolete. Returns the modifiable element of this request having
the specified name creating it if doesn't exist already.
Deprecated, use GetElement(Name) instead.
|
| GetElement(Name) | Returns the modifiable element of this request having
the specified name creating it if doesn't exist already.
|
| HasElement(String) | Obsolete.
Returns true if this request contains the element having the specified
name false otherwise.
Deprecated, use HasElement(Name) instead.
|
| HasElement(Name) |
Returns true if this request contains the element having the specified
name false otherwise.
|
| Print(Stream) | Prints the contents of this message to the specified Stream.
|
| Print(TextWriter) | Prints the contents of this message to the specified TextWriter.
|
| Set(String, Constant) | Obsolete. Sets the element of this request having the specified name to the
specified value.
Deprecated, use Set(Name, Constant) instead.
|
| Set(String, Datetime) | Obsolete. Sets the element of this request having the specified name to the
specified value.
Deprecated, use Set(Name, Datetime) instead.
|
| Set(String, Name) | Obsolete. Sets the element of this request having the specified name to the
specified value.
Deprecated, use Set(Name, Name) instead.
|
| Set(String, Boolean) | Obsolete. Sets the element of this request having the specified name to the
specified value.
Deprecated, use Set(Name, Boolean) instead.
|
| Set(String, Byte) | Obsolete. Sets the element of this request having the specified name to the
specified value.
Deprecated, use Set(Name, Byte) instead.
|
| Set(String, Char) | Obsolete. Sets the element of this request having the specified name to the
specified value.
Deprecated, use Set(Name, Char) instead.
|
| Set(String, Double) | Obsolete. Sets the element of this request having the specified name to the
specified value.
Deprecated, use Set(Name, Double) instead.
|
| Set(String, Int32) | Obsolete. Sets the element of this request having the specified name to the
specified value.
Deprecated, use Set(Name, Int32) instead.
|
| Set(String, Int64) | Obsolete. Sets the element of this request having the specified name to the
specified value.
Deprecated, use Set(Name, Int64) instead.
|
| Set(String, Single) | Obsolete. Sets the element of this request having the specified name to the
specified value.
Deprecated, use Set(Name, Single) instead.
|
| Set(String, String) | Obsolete. Sets the element of this request having the specified name to the
specified value.
Deprecated, use Set(Name, String) instead.
|
| Set(Name, Constant) | Sets the element of this request having the specified name to the
specified value.
|
| Set(Name, Datetime) | Sets the element of this request having the specified name to the
specified value.
|
| Set(Name, Name) | Sets the element of this request having the specified name to the
specified value.
|
| Set(Name, Boolean) | Sets the element of this request having the specified name to the
specified value.
|
| Set(Name, Byte) | Sets the element of this request having the specified name to the
specified value.
|
| Set(Name, Char) | Sets the element of this request having the specified name to the
specified value.
|
| Set(Name, Double) | Sets the element of this request having the specified name to the
specified value.
|
| Set(Name, Int32) | Sets the element of this request having the specified name to the
specified value.
|
| Set(Name, Int64) | Sets the element of this request having the specified name to the
specified value.
|
| Set(Name, Single) | Sets the element of this request having the specified name to the
specified value.
|
| Set(Name, String) | Sets the element of this request having the specified name to the
specified value.
|
RemarksRequest 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 SafetyAny 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