CachedObjectIdGetStringKey Method

ScaleOut Software NamedCache API
Retrieves the original (unhashed) string used as a key to a StateServer object.

Namespace:  Soss.Client
Assembly:  soss_namedcache (in soss_namedcache.dll) Version:

public string GetStringKey()

Return Value

Type: String
A String value that was provided as a key when the associated object was created. Returns null if the object is not in the cache or if the key to the object was created with a datatype other than String.

This call may cause a round-trip to the StateServer if the CachedObjectId in question was not constructed by the user with the original string. (That is, if the CachedObjectId instance was provided to the user in an expiration event as an EventArg or in an asynchronous database read-ahead/write-behind handler then the GetKeyString method may need to perform a round-trip to the server to retrieve the original key.)

This method should not be used to check for the existence of an object in the cache.

See Also