Main Content

category

Field category search for Bloomberg B-PIPE connection V3

Description

example

d = category(c,f) returns category information given the search term f using the Bloomberg® B-PIPE® C++ interface.

Examples

collapse all

Create a Bloomberg connection, and then request the category description of 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 category function returns data as a cell array.

c.DataReturnFormat = 'table';

Request the Bloomberg category description of the last price field.

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

Display the first three rows of the Bloomberg category description data in d.

d(1:3,:)
ans =

  3×5 table

     CATEGORY       ID                   MNEMONIC                          DESCRIPTION               DATATYPE
    __________    _______    ________________________________    ________________________________    ________

    'Analysis'    'OP179'    'THETA_LAST'                        'Theta Last Price'                  'Double'
    'Analysis'    'VM048'    'DDMX_PERCENT_CHANGE_LAST_PRICE'    'DDMX Percent Change Last Price'    'Double'
    'Analysis'    'YL005'    'YLD_CNV_LAST'                      'Last Yield To Convention'          '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 to denote Bloomberg fields.

Data Types: char | string

Output Arguments

collapse all

Category 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 category data depends on the DataReturnFormat property of the connection object.

Introduced in R2021a