Difference between revisions of "GetAccount"
Jump to navigation
Jump to search
(Created page with " Category:Accounts & Positions") |
|||
Line 1: | Line 1: | ||
+ | Returns the account number for the account at a specific location in the list of accounts. | ||
+ | |||
+ | If the value returned by <code>[[GetNumAccounts]]</code> is a non-zero, then: | ||
+ | |||
+ | for <code>1 <= AccountLoc <=</code> <code>[[GetNumAccounts]]</code>, the function returns the account number. | ||
+ | |||
+ | For other sequence numbers an empty string ("") is returned. | ||
+ | |||
+ | == Usage == | ||
+ | <syntaxhighlight>GetAccount(AccountLoc)</syntaxhighlight> | ||
+ | |||
+ | Where: | ||
+ | : <code>AccountLoc</code> - the sequence number of the account in the list of accounts. | ||
+ | |||
+ | == Notes == | ||
+ | This function can be used along with <code>[[GetNumAccounts]]</code>, to enumerate available accounts returned by broker. | ||
+ | |||
+ | == Example == | ||
+ | The broker returned the following list of accounts: "DU12345", "DU23456", "DU34567", "DU45678". | ||
+ | |||
+ | <syntaxhighlight>GetAccount(3)</syntaxhighlight> will return <code>"DU34567"</code>. | ||
+ | |||
+ | <syntaxhighlight>GetAccount(5)</syntaxhighlight> will return <code>""</code>. | ||
[[Category:Accounts & Positions]] | [[Category:Accounts & Positions]] |
Latest revision as of 14:13, 24 February 2012
Returns the account number for the account at a specific location in the list of accounts.
If the value returned by GetNumAccounts
is a non-zero, then:
for 1 <= AccountLoc <=
GetNumAccounts
, the function returns the account number.
For other sequence numbers an empty string ("") is returned.
Usage
GetAccount(AccountLoc)
Where:
AccountLoc
- the sequence number of the account in the list of accounts.
Notes
This function can be used along with GetNumAccounts
, to enumerate available accounts returned by broker.
Example
The broker returned the following list of accounts: "DU12345", "DU23456", "DU34567", "DU45678".
GetAccount(3)
will return "DU34567"
.
GetAccount(5)
will return ""
.