|
Syntax
Public Function UpdateGroup (ByRef ClientID As Integer, ByRef Name As String,ByRef Username As String ,ByRef Password As String, 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 group with new data. After UpdateGroup method executes the UpdateGroupRecieved event fires.
Parameters
| Parameter |
Description |
| ClientID |
Group number to be updated, value of type is Integer |
| Name |
Group name, value of type is String |
| Username |
Group user name , value of type is String. |
| Password |
Group password, value of type is String |
| ReadOnly |
If it true then the group can only monitor the trades, value of type is Boolean |
| Phone |
Group Telephone number, value of type is String |
| Fax |
Group Fax number, value of type is String |
| Mobile |
Group Mobile number, value of type is String |
| TelFax |
Group TelFax number, value of type is String |
| POB |
Post Office box, value of type is String |
| Email |
Group Email ,value of type is String |
| Address |
Group 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 UpdateGroup_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles UpdateGroup.Click
'BOAPI is a predefined variable as CVertexFXBOAPI10
Dim Result as CallingResultsEnum
Dim vClient As COClient
vClient = BOAPI.ClientByIndex(1)
Result= BOAPI.UpdateGroup(vClient.ClientID,”Name”,”UserName”,” Password”, False, ”Phone”, ”Fax” , ”Mobile”, ”TelFax”, ”POB”, “Email”, ”Address”)
Msgbox (Result.ToString)
End Sub
See Also
VertexFX Backoffice API Index
| 
(0 vote(s))