IdeaBlade DevForce 2010 Help Reference
GetKey Method
See Also  Send Feedback
IdeaBlade.EntityModel Assembly > IdeaBlade.EntityModel Namespace > DefaultDataSourceKeyResolver Class : GetKey Method



keyName
Data source key name
keyExtension
Extension or empty string
onServer
True if called from the Entity Server
Returns the IdeaBlade.Core.IDataSourceKey for a given key name and extension.

Syntax

Visual Basic (Declaration) 
Public Overridable Function GetKey( _
   ByVal keyName As String, _
   ByVal keyExtension As String, _
   ByVal onServer As Boolean _
) As IDataSourceKey
Visual Basic (Usage)Copy Code
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)
C# 
public virtual IDataSourceKey GetKey( 
   string keyName,
   string keyExtension,
   bool onServer
)
C++/CLI 
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 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows Server 2008 family

See Also

© 2013 All Rights Reserved.