When this method is implemented in a class, it should return a URI-path encoded string that encodes the values in keyValues.

Namespace: BrightstarDB.EntityFramework
Assembly: BrightstarDB (in BrightstarDB.dll) Version: 1.9.0.0 (1.9.0.0)

Syntax

C#
string GenerateKey(
	Object[] keyValues,
	string keySeparator,
	Type forType
)
Visual Basic
Function GenerateKey ( 
	keyValues As Object(),
	keySeparator As String,
	forType As Type
) As String
Visual C++
String^ GenerateKey(
	array<Object^>^ keyValues, 
	String^ keySeparator, 
	Type^ forType
)
F#
abstract GenerateKey : 
        keyValues : Object[] * 
        keySeparator : string * 
        forType : Type -> string

Parameters

keyValues
Type: array<System..::..Object>[]()[][]
The composite key values to be encoded
keySeparator
Type: System..::..String
The configured separator string to insert between key values
forType
Type: System..::..Type
The type of entity that the key is being encoded for

Return Value

Type: String
A URI-path encoded string, or null if the key could not be generated (e.g. because one or more of the key values are not specified or out of range).

Remarks

The keySeparator and forType parameters are provided for information. The converter SHOULD honour the keySeparator parameter when inserting separators between key values.

See Also