LV_SRE_OpenPort

Opens the speech port and initializes a connection to the Speech Engine.

Functions

HPORT LV_SRE_OpenPort(ExportLogMsg Log, void* p, intverbosity);

HPORT LV_SRE_OpenPort2(unsigned long* error_code, ExportLogMsg Log, void* p, int verbosity);

Return Values

Note: the returned handle is used by most other API functions, and must be closed by calling LV_SRE_ClosePort.

Non-NULL

Port initialized successfully.

NULL

Licensing has been exceeded. There are too many ports active.

Parameters

Log

Pointer to a function which will receive logging information from the object.

A void pointer to client application-defined data. This data will be passed into the ExportLogMsg function to identify the calling port.

verbosity

range: 0 - 6

0 - minimal logging info

6 - maximum logging info

error_code

An error message indicating why the port failed to open

Error Code Return Values for OpenPort2

LV_SUCCESS

The port opened successfully

LV_NO_SERVER_RESPONDING or LV_OPEN_PORT_FAILED__PRIMARY_SERVER_NOT_RESPONDING

The client could not find a server to request a licensed port from.

LV_OPEN_PORT_FAILED__LICENSES_SUCCEEDED

The primary server has too many ports connected for the number of licenses it has to give out.

This function activates the speech port object. The recognition engine will begin initializing when this function is called. Control will return to the application immediately.

p is passed into the ExportLogMsg function to enable client-application-defined behavior.

Remarks