Assign a character map for this query.
Namespace: NetricsServerInterface
Assembly: NetricsServerInterface (in NetricsServerInterface.dll)
Syntax
| Visual Basic (Declaration) |
|---|
| Public Sub useCharmap( _ ByVal charmap_name As String _ ) |
| C# |
|---|
| public void useCharmap( string charmap_name ) |
| C++ |
|---|
| public: void useCharmap( String charmap_name ) sealed |
| J# |
|---|
| public void useCharmap( string charmap_name ) |
| JScript |
|---|
| public
function useCharmap( charmap_name : String ) |
Parameters
- charmap_name
- the name of the character map to be used.
Remarks
Use this method with extreme caution.
This method is only applicable to Simple, Cognate and Attribute queries. If called on any other query type it throws an exception.
Normally the character map applied to a query is determined by the character mapping applied to the fields. However an attempt to query across fields using different character maps will throw a parameter conflict error. In general the character map used by the query should always be the same as the character map for the fields being queried. Using different character maps can result in very poor or completely erroneous match results. The conflict error is thrown to prevent inadvertently obtaining erroneous results due to mismatched character maps.
However in some rare circumstance, if the character maps are very similar, it may be possible and desirable to perform a search across fields with different character maps. This method allows the user to override the conflict error and explicitly set the character map to be used for this query.