Syntax
Public Function ChangeParam(ClientID As Integer, ParamType As ParamTypeEnum, InheritValue As Boolean, newValue As String, Optional SymbolIDs As String = "-1") As CallingResultsEnum
Description
This function used to change a parameter value according to given parameter type for a specific groups, offices or clients.
Parameters
Part |
Description |
ClientID |
The client ID which you want to change its parameter, value of type Integer |
ParamType |
Parameter type, value of type ParamTypeEnum |
InheritValue |
Boolean Parameter, if true the parameter will be inherited from the upper parent,if false the parameter value will be overridden |
NewValue |
The value of parameter, if the InheritValue is false |
SymbolsIDs |
Trading symbols numbers separated by comma “,” |
Return value
This Returns value of type CallingResultsEnum. if the request sent to the server successfully it will return SuccessResult.
Sample
Public WithEvents BOAPI As CVertexFXBOAPI
Private Sub Button1_Click (sender As System.Object, e As System.EventArgs) Handles Button1.Click
Dim Result As CallingResultsEnum
Dim vClient As COClient
vClient = BOAPI.ClientByIndex(1)
Result = BOAPI.ChangeParam(vClient.ClientID, ParamTypeEnum.AutoBrokerIfLessType, False, True, 6)
MsgBox(Result.ToString)
End Sub
See Also
VertexFX Backoffice API Index
|