Share via


LockObject (Command Interface)

Note

  This feature will be removed in the next version of Microsoft SQL Server. Do not use this feature in new development work, and modify applications that currently use this feature as soon as possible.

The LockObject method of the Command interface locks an object to prevent multiple users from concurrently changing the object.

Applies To: clsDatabaseCommand

Syntax

object.LockObject(ByVal LockType As OlapLockTypes, ByVal LockDescription As String)

Parameters

  • object
    The object to lock.

  • LockType
    One of the lock types of the OlapLockTypes enumeration. For more information, see OlapLockTypes.

  • LockDescription
    A string that contains a description of the lock. This argument is available to other applications attempting to obtain a lock.

Remarks

Of the four types of locks defined by the OlapLockTypes enumeration, only olapLockRead and olapLockWrite apply to the Command interface.

Lock type

Applies to

olapLockRead

Applications can read the properties of the command object from the repository but cannot make changes until the lock is released (this includes the application that created the lock).

olapLockWrite

The application that created the lock can modify the object's properties and save them in the repository using the Update method. Other applications cannot read the properties of the object until the lock is released.

For more information about object locking, see LockObject.

Example

The following example locks a command object so that it can be modified. It then unlocks the object and updates the repository information for that object.

'Assume a command object (dsoCmd) exists.
dsoCmd.LockObect OlapLockRead, "Updating command, please wait."
' (Insert code to change command object here.)
dsoCmd.Update
dsoCmd.UnlockObject

See Also

Reference