GetKey Method (DefaultDataSourceKeyResolver)

Returns the IdeaBlade.Core.IDataSourceKey for a given key name and extension.

Syntax

Visual Basic
C#

'Declaration
 
Public Overridable Function GetKey( _
   ByVal keyName As String, _
   ByVal keyExtension As String, _
   ByVal onServer As Boolean _
) As IDataSourceKey

'Usage
 
Dim instance As DefaultDataSourceKeyResolver
Dim keyName As String
Dim keyExtension As String
Dim onServer As Boolean
Dim value As IDataSourceKey
 
value = instance.GetKey(keyName, keyExtension, onServer)

public virtual IDataSourceKey GetKey( 
   string keyName,
   string keyExtension,
   bool onServer
)

Parameters

keyName: Data source key name
keyExtension: Extension or empty string
onServer: True if called from the Entity Server

Return Value

Concrete data source key

Remarks

GetKey searches the keys specified in the IdeaBlade configuration file for the first key matching the name and extension provided. If an extension is provided, key name matching is first done for the "keyName_ext" pattern; if not found then the "keyName_ext_*" pattern is used; and finally if still not found the search is for the keyName only.

If an extension is not provided (either null or empty string) then only the keyName lookup is done.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

DefaultDataSourceKeyResolver Class
DefaultDataSourceKeyResolver Members