SalObject

PPJ.Runtime.Com.SalObject

Namespace: PPJ.Runtime.Com

Assembly: PPJ.Runtime.49 (4.9.0.0)

Summary description for SalObject.

C#

public class SalObject : SalFunctionalClass, IDisposable

VB.NET

Public Class SalObject
    Inherits SalFunctionalClass
    Implements IDisposable

Constructors

SalObject()

Construct a new null SalObject. This class cannot be used as second-base class.

SalObject(obj)

Constructs a new SalObject and wraps the specified com object instance.

Name	Type	Description
obj	Object

Properties

AutoErrorMode

Boolean: Turns on/off automatic COM error handling.

AutoRelease

Boolean: Turns on/off auto-release mode. When true, the runtime will force the release of the underlying COM object.

Value

Object: Returns/Sets the inner COM object instance

Methods

Attach(obj)

Attaches the object to this IDispatch.

Parameter	Type	Description
obj	SalObject

Returns: Boolean.

Count()

get number of objects

Returns: SalNumber.

CreateObject()

Inspects the current class for the _CoClass member and creates the inner COM object and assigns it to the inner _Interface member.

Returns: Boolean.

CreateObject(progid)

Creates the com object from the progid.

Parameter	Type	Description
progid	String

Returns: Boolean.

CreateObjectEx(host)

Creates the com object on a remote host.

Parameter	Type	Description
host	String

Returns: Boolean.

CreateObjectEx(progid, host)

Creates the com object on a remote host.

Parameter	Type	Description
progid	String
host	String

Returns: Boolean.

Detach()

Releases the attached COM object.

Returns: Boolean.

Dispose()

Dispose object

GetInterface(iface, iid)

Returns the requested com interface.

Parameter	Type	Description
iface	SalObject
iid	String

Returns: Boolean.

GetLastError(err)

Returns the last COM exception into a OleErrorInfo object.

Parameter	Type	Description
err	SalOleErrorInfo

Returns: SalBoolean.

HandleException(e)

handle exception

Parameter	Type	Description
e	Exception

Returns: Boolean.

IsCollection()

is collection

Returns: SalBoolean.

IsDispatchValid()

Checks whether the underlying COM object is valid.

Returns: Boolean.

MTSDisableCommit()

Indicates that the object's transactional updates cannot be committed in the present time until SalMTSEnableCommit() or SalMTSSetComplete() is called. For non-MTS components the SalMTSDisableCommit() will fail (returns false).

MTSEnableCommit()

Indicates that the object’s work is not necessarily done, but that its transactional updates can be committed in their current form (stateful object). EnableCommit is the default state when an object is activated. For non-MTS components the SalMTSEnableCommit() will fail (returns false).

MTSIsCallerInRole(role)

Determines whether the caller is in the specified role.

Parameter	Type	Description
role	SalString

Returns: SalBoolean.

MTSIsInTransaction()

This method checks if the component is executing in the transaction context. For non-MTS components the SalMTSIsInTransaction() will fail (returns false).

Returns: Boolean. bOk

MTSIsSecurityEnabled()

This method checks for the security status. If the object is running in the client's process, there is no security checking and SalMTSIsSecurityEnabled will always return false. For non-MTS components the SalMTSIsSecurityEnabled() will fail (returnS false).

Returns: Boolean. bOk

MTSSetAbort()

Indicates that the object’s work can never be committed. The entire transaction is aborted. The object is deactivated upon return from the method. For non-MTS components the SalMTSSetAbort() will fail (returnS false).

MTSSetComplete()

Indicates that the object has successfully completed its work for the transaction. The object is deactivated upon return from the method that first entered the context (stateless object). For non-MTS components the SalMTSSetComplete() will fail (returns false).

Next(obj)

next object

Parameter	Type	Description
obj	SalObject

Returns: SalBoolean.

Reset()

reset

Returns: SalBoolean.

Skip(nElems)

skip element

Parameter	Type	Description
nElems	SalNumber

Returns: SalBoolean.