fieldinfo

Field information for Bloomberg B-PIPE connection V3

Since R2021a

Syntax

d = fieldinfo(c,f)

Description

d = fieldinfo(c,f) returns field information using the bloombergBPIPE object c with the Bloomberg^® B-PIPE^® C++ interface and field mnemonic f.

Examples

Retrieve Information for Last Price Field

Create a Bloomberg connection, and then retrieve information for the last price field.

Create a Bloomberg B-PIPE connection using the IP address of the machine running the Bloomberg B-PIPE process. This example uses the Bloomberg B-PIPE C++ interface and assumes the following:

• The authentication is Windows^® authentication when you set authtype to 'OS_LOGON'.

• The application name is blank because you are not connecting to Bloomberg B-PIPE using an application.

• The IP address for the machine running the Bloomberg B-PIPE process is '111.11.11.112'.

• The port number of the machine running the Bloomberg B-PIPE process is 8194.

c is a bloombergBPIPE object.

authtype = 'OS_LOGON';
appname = '';
ipaddress = {'111.11.11.112'};
port = 8194;

c = bloombergBPIPE(authtype,appname,ipaddress,port);

Return data as a table by setting the DataReturnFormat property of the bloomberg object. If you do not set this property, the fieldinfo function returns data as a cell array.

c.DataReturnFormat = 'table';

Retrieve the Bloomberg field information for the LAST_PRICE field.

f = 'LAST_PRICE';
d = fieldinfo(c,f);

Display the last four columns in the returned Bloomberg information.

d(:,2:5)

ans =

  1×4 table

      ID         MNEMONIC            DESCRIPTION          DATATYPE
    _______    ____________    _______________________    ________

    'RQ005'    'LAST_PRICE'    'Last Trade/Last Price'    'Double'

The columns in d are:

• Field identifier

• Field mnemonic

• Field name

• Field data type

You can also access the Bloomberg help information in the first column.

Close the Bloomberg connection.

close(c)

Input Arguments

c — Bloomberg B-PIPE connection

bloombergBPIPE object

Bloomberg B-PIPE connection, specified as a bloombergBPIPE object.

f — Field mnemonic

character vector | string scalar

Field mnemonic, specified as a character vector or string scalar that denotes the Bloomberg field information to retrieve.

Data Types: char | string

Output Arguments

d — Field information

cell array (default) | structure | table

Field information, returned as an N-by-5 cell array, a structure, or a table.

The columns (or fields) of the data types are:

• Field help

• Field identifier

• Field mnemonic

• Field name

• Field data type

The data type of the field information depends on the DataReturnFormat property of the connection object.

Version History

Introduced in R2021a