Syntax
Public Function UpdateClient (ClientID As Integer,FirstName As String,SecondName As String,ThirdName As String, LastName As String,UserName As String,Password As String,Tel As String,Mobile As String,TelFax As String,POB As String,Fax As String,Email As String,Address As String,ReadOnly As Boolean,Country As String) As VertexFXBOAPI.CallingResultsEnum
Description
This function used to modify the provided client with new data, after UpdateClient method executes the UpdateClientRecieved event fires.
Parameters
Parameter |
Description |
ClientID |
Client number to be updated, value of type is Integer |
FirstName |
Client first name, value of type is String |
SecondName |
Client second name, value of type is String |
ThirdName |
Client third name, value of type is String |
LastName |
Client last name, value of type is String |
UserName |
Client username, value of type is String |
Password |
Client password, value of type is String |
Tel |
Client telephone number, value of type is String |
Mobile |
Client mobile number, value of type is String |
TelFax |
TelFax number, value of type is String |
POB |
Post Office box, value of type is String |
Fax |
Fax number of client, value of type is String |
Email |
Client email, value of type is String |
Address |
Client address, value of type is String |
ReadOnly |
If true then the client only monitor the trades ,value of type is Boolean |
Country |
Client country, value of type is String |
Return value
Returns a value of type CallingResultsEnum. if the request sent to the server successfully it will return SuccessResult.
Sample
Private Sub UpdateClient_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles UpdateClient.Click
'BOAPI is a predefined variable as CVertexFXBOAPI10
Dim Result as CallingResultsEnum
Dim vClient As COClient
vClient = BOAPI.ClientByIndex(1)
Result = BOAPI.UpdateClient (vClient.ClientID, ”FirstName”,” SecondName”, ”ThirdName”, ”ThirdName”, ”LastName” , ”UserName”, ”Password”, ”Telephone”, ”Mobile”, ”TelFax”, ”POB”, ”Email”, ”Address”, False, ”Country”)
Msgbox (Result)
End Sub
See Also
VertexFX Backoffice API Index
|