createOrderProfile

Create order profile for X_TRADER

collapse all in page

Syntax

P = createOrderProfile(X,S)
P = createOrderProfile(X,Name,Value)

Description

example

P = createOrderProfile(X,S) creates an order profile defined by the structure S with fields corresponding to valid X_TRADER® API options. For details, see the Trading Technologies® X_TRADER API RTD Tutorial or X_TRADER API Class Reference.

example

P = createOrderProfile(X,Name,Value) creates an order profile using X_TRADER API options specified by one or more Name,Value pair arguments with names and values corresponding to valid X_TRADER API options. For details, see the Trading Technologies X_TRADER API RTD Tutorial or X_TRADER API Class Reference.

Examples

collapse all

Start X_TRADER.

X = xtrdr;

Define an input structure, S, with fields corresponding to valid X_TRADER API options.

S = [];
S.Instrument = [];
S.Customer = '';
S.Alias = '';
S.ReadProperties = 'b';
S.WriteProperties = 'b';
S.Customers = {'<Default>'};
S.RoundOption = 2;
S.CustomerDefaults = [];
S
S = 

          Instrument: []
            Customer: ''
               Alias: ''
      ReadProperties: 'b'
     WriteProperties: 'b'
           Customers: {'<Default>'}
         RoundOption: 2
    CustomerDefaults: []

Create an order profile.

P = createOrderProfile(X,S);

Close the connection.

close(X)

Start X_TRADER.

X = xtrdr;

Create an order profile using name-value pairs corresponding to valid X_TRADER API options.

createOrderProfile(X,'Instrument',[],'Customer','',...
             'Alias','','ReadProperties','b',...
             'WriteProperties','b','Customers',{'<Default>'},...
             'RoundOption',2,'CustomerDefaults',[])

Close the connection.

close(X)

Input Arguments

collapse all

X_TRADER connection, specified as a connection object created using xtrdr.

xtrdr input structure, specified with fields corresponding to valid X_TRADER API options. For details, see the Trading Technologies X_TRADER API RTD Tutorial or X_TRADER API Class Reference.

Example: S = [];
S.Exchange = 'Eurex';
S.Product = 'OGBM';
S.ProdType = 'Option';
S.Contract = 'Jan12 P12300';
S.Alias = 'TestInstrument3';

Data Types: struct

Name-Value Pair Arguments

Specify optional comma-separated pairs of Name,Value arguments. Name is the argument name and Value is the corresponding value. Name must appear inside quotes. You can specify several name and value pair arguments in any order as Name1,Value1,...,NameN,ValueN.

Example: createOrderProfile(X,'Instrument',[],'Customer','<Default>','Alias','','RoundOption',2,'CustomerDefaults')

Valid X_TRADER API options, specified as a character vector or string scalar using the details described in Trading Technologies X_TRADER API RTD Tutorial or X_TRADER API Class Reference.

Example: createOrderProfile(X,'Instrument',[],'Customer','<Default>','Alias','','RoundOption',2,'CustomerDefaults')

Data Types: char | string

Valid X_TRADER API options, specified as a character vector or string scalar using the details described in Trading Technologies X_TRADER API RTD Tutorial or X_TRADER API Class Reference.

Example: createOrderProfile(X,'Instrument',[],'Customer','<Default>','Alias','','RoundOption',2,'CustomerDefaults')

Data Types: char | string

Output Arguments

collapse all

Order profile, returned as a structure.

See Also

| | |

Topics

External Websites

Introduced in R2013a

Trading Toolbox Documentation
Support