VertexFX BackOffice WCF Service

ChangeClientParam

132 views 0 Updated on September 20, 2023 hybrid-solutions

Syntax

Public Function ChangeClientParam(ClientID As Long, ParamType As Long, InheritValue As Boolean, NewValue As String, Optional ByVal SymbolIDs As String = "-1") As String

Description

This function is used to change the Symbols and the value of the general parameter for the given clientID which the logged-in dealer has privilege on.

Parameters

Name Description Required
ClientID
  • The client number to get his parameters
  • Type: Long
  • Default: None
 Yes
ParamType
  • The parameter that wants to change its value
  • Type: Can Be one of the ParamTypeEnum
  • Default: None
 Yes
InheritValue
  • To indicate if the value will be inherited from the client’s parent or not
  • Type: Boolean
  • Default: None
 Yes
NewValue
  • The new value which wants to be set if the inheritance is false
  • Type: String
  • Default: None
 Yes
SymbolIDs
  • The Symbol IDs which want to change their value are separated by a comma(,).
  • Type : String
  • Default = -1
  • Note: set this value (-1) when changing the client’s general parameter
No

Response Elements

Name Description
Result The The operation return 1 in case success , otherwise and explicit error code is returned

See Also

VertexFX BackOffice WCF Service Index

Was this helpful?