Application Methods for COM Data Control

The following table describes a summary of application methods you can use with COM Data Control. It does not include object interface methods that Siebel CRM does not call directly from an application instance. For information about methods that Siebel CRM calls with the InvokeMethod method on the application object, see LoadObjects Method for an Application.

Method	Description	Format
Attach Method for an Application	Allows an external application to reconnect to an existing Siebel session.	Dim application as SiebelDataControl Dim status as Boolean status = application.Attach(sessionID As String)
CurrencyCode Method for an Application	Returns the currency code that is associated with the division of the user position.	Dim application as SiebelDataControl Dim sCur as String sCur = Application.CurrencyCode
Detach Method for an Application	Returns a string that contains the Siebel session ID.	Dim application as SiebelDataControl Dim sessionId as String sessionId = application.Detach()
EnableExceptions Method for an Application	Enables or disables native Component Object Model (COM) error handling.	Dim application as SiebelDataControl Dim bEnable as Boolean bEnable = trueapplication.EnableExceptions(bEnable)
GetBusObject Method for an Application	Creates a new instance of a business object.	Dim application as SiebelDataControl Dim busObject as SiebelBusObject set busObject = application.GetBusObject(busobjName as String)
GetLastErrCode Method for an Application	Returns the error code for the error that Siebel CRM logged most recently.	Dim application as SiebelDataControl Dim iErr as Integer iErr = application.GetLastErrCode
GetLastErrText Method for an Application	Returns the text message for the error that Siebel CRM logged most recently.	Dim application as SiebelDataControl Dim sText as String sText = application.GetLastErrText
GetProfileAttr Method for an Application	Returns the name of an attribute in a user profile.	Dim application as SiebelDataControl Dim sText as String sText = application.GetProfileAttr(profileAttributeName as string)
GetService Method for an Application	Locates a business service. If this business service is not already running, then Siebel CRM starts it.	Dim application as SiebelDataControl Dim service as SiebelService set service = application.GetService(serviceName as String)
GetSharedGlobal Method for an Application	Returns the shared global variables.	Dim application as SiebelDataControl Dim sText as string sText = application.GetSharedGlobal(globalVariableName as string)
InvokeMethod Method for an Application	Calls a method.	Dim application as SiebelDataControl Dim sReturn as String sReturn = application.InvokeMethod(methodName as String, methArg1, methArg2, methArgN as String or StringArray)
Login Method for an Application	Allows an external application to log in to the COM Data Server, COM Data Control, or Siebel Java Data Bean, and to access Siebel objects.	Dim application as SiebelDataControl Dim sErr as String sErr = application.Login(connectString as String, userName as String, password as String)
LoginId Method for an Application	Returns the login ID of the user who started the Siebel application.	Dim application as SiebelDataControl Dim sID as String sID = application.LoginId
LoginName Method for an Application	Returns the login name of the user who started the Siebel application.	Dim application as SiebelDataControl Dim sUser as String sUser = application.LoginName
Logoff Method for an Application	Disconnects the Siebel client from the Siebel Server.	Dim SiebApp as SiebelDataControl Dim boolVal as Boolean boolVal = siebApp.LogOff
NewPropertySet Method for an Application	Creates a new property set.	Dim application as SiebelDataControl Dim PropSet as SiebelPropertySet PropSet = oApplication.NewPropertySet
PositionId Method for an Application	Returns the position ID of the user position.	Dim application as SiebelDataControl Dim sRow as String sRow = application.PositionId
PositionName Method for an Application	Returns the name of the current user position.	Dim application as SiebelDataControl Dim sPosition as String sPosition = application.PositionName
SetPositionId Method for an Application	Sets the active position to a Position ID.	Dim application as SiebelDataControl Dim status as Boolean status = application.SetPositionId(sPosId)
SetPositionName Method for an Application	Sets the active position to a position name.	Dim application as SiebelDataControl Dim status as Boolean status = application.SetPositionName(sPosName)
SetProfileAttr Method for an Application	Personalization uses this method to set a value for an attribute in a user profile.	Dim application as SiebelDataControl application.SetProfileAttr(name as String, value as String)
SetSharedGlobal Method for an Application	Sets a shared global variable.	Dim SiebApp as SiebelDataControl Dim boolVal as Boolean boolVal = SiebApp.SetSharedGlobal(varName As String, value As String)
Trace Method for an Application	Appends a message to the trace file.	Dim SiebApp as SiebelDataControl Dim boolVal as Boolean boolVal = siebApp.TraceOn(msg As String)
TraceOff Method for an Application	Turns off tracing.	Dim SiebApp as SiebelDataControl Dim boolVal as Boolean boolVal=siebApp.TraceOff
TraceOn Method for an Application	Turns on tracing.	Dim SiebApp as SiebelDataControl Dim boolVal as Boolean boolVal = siebApp.TraceOn(fileName As String, category As String, src As String)