|
Syntax
Public Function UpdateOffice (ByRef ClientID As Integer, ByRef Name As String, ByRef UserName As String, ByRef Password As String, ByRef WhiteLabeled As Boolean, ByRef Demo As Boolean, ByRef ReadOnly As Boolean, ByRef Phone As String, ByRef Fax As String, ByRef Mobile As String, ByRef TelFax As String, ByRef POB As String, ByRef Email As String, ByRef Address As String) As CallingResultsEnum
Description
This function used to modify the given Office number with new data. After UpdateOffice method executes the UpdateOfficeRecieved event fires.
Parameters
| Parameter |
Description |
| ClientID |
Office number to be updated, value of type is Integer |
| Name |
Office name, value of type is String |
| Password |
Office password, value of type is String |
| WhiteLabeled |
If it true then the Office is a white label, value of type is Boolean |
| ReadOnly |
If it true then the Office can only monitor the trades, value of type is Boolean |
| Phone |
Office Telephone number, value of type is String |
| Fax |
Office Fax number, value of type is String |
| Mobile |
Office Mobile number, value of type is String |
| TelFax |
Office TelFax number, value of type is String |
| POB |
Post Office box, value of type is String |
| Email |
Office Email ,value of type is String |
| Address |
Office Address ,value of type is String |
Return value
Returns a value of type CallingResultsEnum.if the request sent to server successfully it will return SuccessResult.
Sample
Private Sub UpdateOffice_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles UpdateOffice.Click
'BOAPI is a predefined variable as CVertexFXBOAPI10
Dim Result as CallingResultsEnum
Dim vClient As COClient
vClient = BOAPI.ClientByIndex(1)
Result= BOAPI. UpdateOffice(vClient.ClientID, ”Name”,” Password”, False, True, ”Phone”, ”Fax” , ”Mobile”, ”TelFax”, ”POB”, “Email”, ”Address”)
Msgbox (Result.ToString)
End Sub
See Also
VertexFX Backoffice API Index
| 
(0 vote(s))