ContentListSchema.Locked Property (PIA)

Article
11/12/2009

The Locked property is a read/write Boolean that indicates whether the ContentListSchema object can be modified. A value of True indicates that the schema is locked and cannot be modified. A value of False indicates that the schema is not locked and can be modified. Once the object is in use it can no longer be modified.

Definition

[Visual Basic .NET]

Imports Microsoft.CommerceServer.Interop.Caching
…
Public Property Locked As Boolean

[C#]

using Microsoft.CommerceServer.Interop.Caching;
…
public bool Locked {get; set; }

Property Value

A bool that specifies the schema lock setting. Since schemas, once locked, cannot be unlocked, only the first call to this property with the Locked parameter set to True will have any effect.

Exceptions

This method may throw one of many mapped exceptions or an exception of type COMException. See Standard COM Errors for additional details.

Remarks

A ContentListSchema object becomes permanently locked as soon as this property is set to true. Once locked, the contained schema cannot be modified or unlocked. ContentListFactory objects will lock the schema as soon as any rows are allocated or any ContentList objects are created, whichever occurs first.

Requirements

Namespace: Microsoft.CommerceServer.Interop.Caching

Platforms: Windows 2000, Windows Server 2003

Assembly: cachecomplib (in cachecomplib.dll)

Share via