fieldsearch

Field search for Bloomberg B-PIPE connection V3

Since R2021a

collapse all in page

Syntax

d = fieldsearch(c,f)

Description

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

example

Examples

collapse all

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 bloombergBPIPE object. If you do not set this property, the fieldsearch function returns data as a cell array.

c.DataReturnFormat = 'table';

Return information for the search term LAST_PRICE.

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

Display the first three rows of the field information in d.

d(1:3,:)

ans =

  3×5 table

           CATEGORY             ID            MNEMONIC                   DESCRIPTION              DATATYPE
    ______________________    _______    ___________________    ______________________________    ________

    'Market Activity/Last'    'PR005'    'PX_LAST'              'Last Price'                      'Double'
    'Market Activity/Last'    'RQ005'    'LAST_PRICE'           'Last Trade/Last Price'           'Double'
    'Market Activity/Last'    'PR910'    'CRNCY_ADJ_PX_LAST'    'Currency Adjusted Last Price'    'Double'

The columns in d are:

  • Category

  • Field identifier

  • Field mnemonic

  • Field name

  • Field data type

Close the Bloomberg connection.

close(c)

Input Arguments

collapse all

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

Search term, specified as a character vector or string scalar that denotes the Bloomberg field descriptive data to retrieve.

Data Types: char | string

Output Arguments

collapse all

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

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

  • Category

  • Field identifier

  • Field mnemonic

  • Field name

  • Field data type

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

Version History

Introduced in R2021a

See Also

| | | | | | |

Topics