ICustomProvider.Delete Method (Object, String, String, Int64)

 

Deletes an existing entry from the configuration store.

Namespace:   Microsoft.ApplicationServer.Caching
Assembly:  Microsoft.ApplicationServer.Caching.Core (in Microsoft.ApplicationServer.Caching.Core.dll)

Syntax

bool Delete(
    object transactionContext,
    string type,
    string key,
    long oldVersion
)

bool Delete(
    Object^ transactionContext,
    String^ type,
    String^ key,
    long long oldVersion
)

abstract Delete : 
        transactionContext:Object *
        type:string *
        key:string *
        oldVersion:int64 -> bool

Function Delete (
    transactionContext As Object,
    type As String,
    key As String,
    oldVersion As Long
) As Boolean

Parameters

• transactionContext
  Type: System.Object

  The transaction context object associated with this entry.

• type
  Type: System.String

  The type of entry to be enumerated.

• key
  Type: System.String

  The key of the entry.

• oldVersion
  Type: System.Int64

  The version of the entry. If this value is less than or equal to 0, the deletion occurs regardless of the version. If this value is greater than 0, then the deletion is only performed if the version of the entry matches the version provided.

Return Value

Type: System.Boolean

Returns Boolean. If the deletion succeeds, the return value is true. If the entry does not exist or if the version does not match, the return value is false.

Remarks

Any unexpected errors should throw a ConfigStoreException exception.

See Also

Delete Overload
ICustomProvider Interface
Microsoft.ApplicationServer.Caching Namespace

Return to top