openMatcherEx() - trillium_quality - 17.1

Trillium Director SDK Reference Guide

Product type
Software
Portfolio
Verify
Product family
Trillium
Product
Trillium > Trillium Quality
Version
17.1
Language
English
Product name
Trillium Quality
Title
Trillium Director SDK Reference Guide
Topic type
Administration
Overview
How Do I
Configuration
Reference
Installation
First publish date
2008

The openMatcherEX() method combines the attach() and openMatcher() methods into a single method.

The returned value is the communication path (handle) to the server. The handle must be used in subsequent API calls to exchange data with the server. (If the returned value is 0, see “Return Values” below.)

Syntax

public int openMatcherEx(char systemID,
                        java.lang.String serverName,
                        int retCode[]);

Parameters

Name

Type

Use

Length

Description

systemID

char

In

1

System ID of requested server.

serverName

string

In

1-8

Name of requested server.

retCode

int[ ]

Out

4

Error code that indicates status of method call.

Return Values

A returned value of 0 indicates a failed attempt to attach to a Director server, and the retCode will indicate the specific error. For a description of the contents of the retCode parameter, refer to Return Values.

Example

TrilTGenClient testClient = new TrilTGenClient();
 
// Return code and handle
int[] retCode      = new int[1];
int handle = 0;
 
// System and Server ID for attach()
char systemID;
String serverName;
systemID = 'G';
serverName = "RMatcher";
// Attach and initialize the session using openMatcherEx()
handle = testClient.openMatcherEx(systemID, serverName, retCode);                        
 
if (retCode[0] == 0) {
 
// Perform relevant processing
// Close the matcher server and release using closeMatcherEx()
  testClient.closeMatcherEx(handle, retCode);
}