OdxConnectEnv

OdxConnectEnv establishes a connection to an Omnidex Environment Catalog via an Omnidex data source file. An instance number is returned in the @instance output parameter. This instance number can be used for all subsequent interaction with the environment catalog, until OdxDisconnectEnv is called.

Syntax

OdxConnectEnv @filename, @instance output[, @options, @username, @pwd]

@filename varchar input
Client data source file name. This is an Omnidex data source file. See DSEDIT for more information.

@instance integer output
The instance number that will be assigned to this connection.

@options varchar input
List of options to be passed to CLoaconnect. Optional.

@username varchar input
The user name to be passed to CLoaconnect. Optional.

@pwd varchar intput
The password to be passed to CLoaconnect. Optional.

Options

See OACONNECT for more options.

Example

This example takes a connection string as input from the calling procedure, establishes a connection, opens a cursor and returns the instance number, cursor number and status.

CREATE PROCEDURE prODXConnect
@connect_string varchar(100),
@instance_no int output,
@cursor_no int output,
@status int output
AS
-- Connect
exec @status = master.dbo.OdxConnectEnv @connect_string, @instance_no output, 'FILE=DSN'
if @status <> 0 return

-- Open a cursor
exec @status = master.dbo.odx_open_cursor @instance_no, @cursor_no output
if @status <> 0 exec prODXDisconnect @cursor_no, @instance_no
GO

Top