|
Syntax
Public Function ChangeDealerParameter(DealerID As Integer, ParameterLevel As DealerParamTypeEnum, parameter As String, InheritValue As Boolean, NewValue As String) As CallingResultsEnum
Description
This function is used to change the symbol, general or privilege parameters for the requested dealer, After ChangeDealerParameter executed the ChangedDealerParameterResultReceived event fired.
Parameters
| Parameters |
Description |
| DealerID |
Dealer identifier to change is dealer parameter. |
| ParameterLevel |
Parameter type which wants to change its value that can be one of the DealerParamTypeEnum. |
| parameter |
This value depend on parameter level type
If it was a symbol the parameter then must be symbol ID
If it was Privilege parameter then must be one of the privEnum.
If it was General Parameter then must be empty String (“”)
|
| InheritValue |
To indicate if the value will be inherent, a value of type Boolean |
| NewValue |
The new value of the parameter which wants to change, value of type String |
Return value
Returns a value of type CallingResultsEnum, If the request was sent to the server successfully it will return SuccessResult.
Sample
Private Sub CreateDealer _Click()
Dim Res as CallingResultsEnum
DealerId = BOAPI..DealerIDByUsername(“Dealer Username”)
Res = BOAPI .ChangeDealerParameter (DealerId,1,"6",True,"-1")
End sub
See Also
VertexFX Backoffice API Index
Last Modified: 29 June 2018
| 
(0 vote(s))