StateServerKeyGetKeyString Method

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

Namespace:  Soss.Client
Assembly:  soss_svcdotnet (in soss_svcdotnet.dll) Version: 6.1.0.0 (1.0.0.0)
Syntax

public string GetKeyString()

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.
Remarks

This call may cause a round-trip to the StateServer if the StateServerKey in question was not constructed by the user with the orignal string. (That is, if the StateServerKey instance was provided to the user in an expiration event as an EventArg or in a 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.

See Also

Reference