Siebel Object Interfaces Reference > COM Data Control Quick Reference >

Application Methods for COM Data Control


Table 36 lists a summary of the application methods' syntax.

Table 36 does not include methods that are not invoked directly from an Application object instance. For information on methods that are called with InvokeMethod on the Application object, see InvokeMethod Methods for the Application Object.

Table 36. Application Methods Syntax Summary
Method
Description
Syntax

Attach Method

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

Returns the three-letter operating currency code.

Dim application as SiebelDataControl
Dim sCur as String
sCur = Application.CurrencyCode

Detach Method

Returns a string containing the Siebel session ID.

Dim application as SiebelDataControl
Dim sessionId as String
sessionId = application.Detach()

EnableExceptions Method

Enables/disables native COM error handling.

Dim application as SiebelDataControl
Dim bEnable as Boolean
bEnable = true
application.EnableExceptions(bEnable)

GetBusObject Method

Instantiates and returns a new instance of the business object specified in the argument.

Dim application as SiebelDataControl
Dim busObject as SiebelBusObject
set busObject = application.GetBusObject(busobjName as String)

GetLastErrCode Method

Returns the last error code.

Dim application as SiebelDataControl
Dim iErr as Integer
iErr = application.GetLastErrCode

GetLastErrText Method

Returns the last error text message.

Dim application as SiebelDataControl
Dim sText as String
sText = application.GetLastErrText

GetProfileAttr Method

Returns the value of an attribute in a user profile.

Dim application as SiebelDataControl
Dim sText as String
sText = application.GetProfileAttr(profileAttributeName as string)

GetService Method

Instantiates and returns a new instance of the argument-specified service.

Dim application as SiebelDataControl
Dim service as SiebelService
set service = application.GetService( serviceName as String)

GetSharedGlobal Method

Returns the shared user-defined global variables.

Dim application as SiebelDataControl
Dim sText as string
sText = application.GetSharedGlobal(globalVariableName as string)

InvokeMethod Method

Calls the named specialized method.

Dim application as SiebelDataControl
Dim sReturn as String
sReturn = application.InvokeMethod(methodName as String, methodArgs as String or StringArray)

Login Method

Allows external applications to log in to the COM Data Server.

Dim application as SiebelDataControl
Dim sErr as String
sErr = application.Login(connectString as String, userName as String, password as String)

LoginId Method

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

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

Disconnects the client from the server.

Dim SiebApp as SiebelDataControl
Dim boolVal as Boolean
boolVal = siebApp.LogOff

NewPropertySet Method

Constructs and returns a new property set object.

Dim application as SiebelDataControl
Dim PropSet as SiebelPropertySet
PropSet = oApplication.NewPropertySet

PositionId Method

Returns the position ID that describes the user's current position.

Dim application as SiebelDataControl
Dim sRow as String
sRow = application.PositionId

PositionName Method

Returns the position name of the user's current position.

Dim application as SiebelDataControl
Dim sPosition as String
sPosition = application.PositionName

SetPositionId Method

Sets the active position to the Position ID specified in the argument.

Dim application as SiebelDataControl
Dim status as Boolean
status = application.SetPositionId(sPosId)

SetPositionName Method

Sets the active position to the position name specified in the argument. Returns a Boolean value indicating whether or not method succeeded.

Dim application as SiebelDataControl
Dim status as Boolean
status = application.SetPositionName(sPosName)

SetProfileAttr Method

Used in personalization to assign values to attributes in a user profile.

Dim application as SiebelDataControl
application.SetProfileAttr(name as String, value as String)

SetSharedGlobal Method

Sets a shared user-defined global variable, which may be accessed using GetSharedGlobal.

Dim SiebApp as SiebelDataControl
Dim boolVal as Boolean
boolVal = SiebApp.SetSharedGlobal(varName As String, value As String)

Trace Method

Appends a message to the trace file.

Dim SiebApp as SiebelDataControl
Dim boolVal as Boolean
boolVal = siebApp.TraceOn(msg As String)

TraceOff Method

Turns off the tracing started by the TraceOn method.

Dim SiebApp as SiebelDataControl
Dim boolVal as Boolean
boolVal=siebApp.TraceOff

TraceOn Method

Turns on the tracking of allocations and deallocations of Siebel objects, and SQL statements generated by the Siebel application.

Dim SiebApp as SiebelDataControl
Dim boolVal as Boolean
boolVal = siebApp.TraceOn(fileName As String, category As String, src As String)

Siebel Object Interfaces Reference Copyright © 2008, Oracle. All rights reserved.