get

Properties of Bloomberg connection V3

Syntax

v = get(c)

v = get(c,properties)

Description

v = get(c) returns a structure where each field name is the name of a property of c and each field contains the value of that property.

v = get(c,properties) returns the value of the specified properties properties for the Bloomberg^® V3 connection object.

Examples

Retrieve Bloomberg Connection Properties

Create the Bloomberg connection.

c = blp;

Alternatively, you can connect to the Bloomberg Server using blpsrv or Bloomberg B-PIPE^® using bpipe.

Retrieve the Bloomberg connection properties.

v = get(c)

v = 

      session: [1x1 com.bloomberglp.blpapi.Session]
    ipaddress: 'localhost'
         port: 8194
      timeout: 0

v is a structure containing the Bloomberg session object, IP address, port number, and timeout value.

Close the Bloomberg connection.

close(c)

Retrieve One Bloomberg Connection Property

Create the Bloomberg connection.

c = blp;

Alternatively, you can connect to the Bloomberg Server using blpsrv or Bloomberg B-PIPE using bpipe.

Retrieve the port number from the Bloomberg connection object by specifying 'port' as a character vector.

property = 'port';
v = get(c,property)

v =

        8194

v is a double that contains the port number of the Bloomberg connection object.

Close the Bloomberg connection.

close(c)

Retrieve Two Bloomberg Connection Properties

Create the Bloomberg connection.

c = blp;

Alternatively, you can connect to the Bloomberg Server using blpsrv or Bloomberg B-PIPE using bpipe.

Create a cell array properties with character vectors 'session' and 'port'. Retrieve the Bloomberg session object and port number from the Bloomberg connection object.

properties = {'session','port'};
v = get(c,properties)

v = 

    session: [1x1 com.bloomberglp.blpapi.Session]
       port: 8194

v is a structure containing the Bloomberg session object and port number.

Close the Bloomberg connection.

close(c)

Input Arguments

c — Bloomberg connection

connection object

Bloomberg connection, specified as a connection object created using blp, blpsrv, or bpipe.

properties — Property names

character vector | string scalar | cell array of character vectors | string array

Property names, specified as a character vector, string scalar, cell array of character vectors, or string array containing Bloomberg connection property names. The property names are session, ipaddress, port, and timeout.

Data Types: char | cell | string

Output Arguments

v — Bloomberg connection properties

numeric scalar | character vector | object | structure

Bloomberg connection properties, returned as these data types depending on the requested properties.

Requested Properties	Data Type
Port number or timeout	Numeric scalar
IP address	Character vector
Bloomberg session	Object
All properties	Structure

Version History

Introduced in R2010a