Chapter 5 C Routines Reference
Alphabetical list of all routines
- JagAlloc - Allocate
memory for use in C component code.
- JagBeginResults - Begin the
sequence of calls that sends a result set to the client.
- JagBindCol - Bind a memory
address to a column in a result set.
- JagCmCacheProps - Retrieve
connection cache properties.
- JagCmGetCachebyName - Retrieve
the handle for the cache with the specified name.
- JagCmGetCachebyUser - Retrieve
a cache handle for connections that use a specified set of values
for server, user name, password, and connectivity library.
- JagCmGetConnection - Retrieve
a connection from a specified cache or from any cache that matches
a specified set of values for server, user name, password, and connectivity
library.
- JagCmGetCtx - Obtain the
connectivity-library-specific context reference that is used to
allocate cached connections in a cache.
- JagCmGetProxyConnection - Retrieve
a cached connection, specifying an alternate login name to set-proxy
to.
- JagCmReleaseConnection - Place a connection
back in the cache for reuse.
- JagColAttributes - Specify additional
metadata for a column to be sent in a result set.
- JagCompleteWork - Indicate
that the component's work for the current transaction was
successfully finished and that this component instance should be
deactivated.
- JagContinueWork - State indicator
routine to specify that the component's work for the current
transaction may be committed.
- JagDescribeCol - Describe
a column to be sent as part of a result set.
- JagDisallowCommit - State indicator
routine to specify that the current transaction cannot be committed
because the component's work has not been completed.
- JagEndResults - Indicate
that all rows in a result set have been sent.
- JagFree - Free memory
that was allocated with JagAlloc.
- JagFreeCollectionHandle - Release the
reference to a collection.
- JagFreeCollectionList - Release the
memory allocated for the JagNameList structure.
- JagFreeSharedDataHandle - Release the
shared variable handle.
- JagGetCollection - Retrieve
a shared-data collection handle.
- JagGetCollectionList - Retrieve
a list of all the collections defined in the server.
- JagGetHostName - Retrieve
the client host name for the client connection that is associated
with a C or C++ component instance.
- JagGetInstanceData - Retrieve
the address of C component instance data.
- JagGetPassword - Retrieve
the password for the client connection that is associated with a
C or C++ instance.
- JagGetPeerAddress - Retrieve
the client host IP address for the client connection that is associated
with a C or C++ component instance.
- JagGetSharedData - Use the shared
variable name to retrieve a shared variable handle.
- JagGetSharedDataByIndex - Use the shared
variable index number to retrieve a shared variable handle.
- JagGetSharedValue - Retrieve
a shared variable value.
- JagGetUserName - Retrieve
the user name for the client connection that is associated with
a C or C++ component instance.
- JagInTransaction - Determine
whether the current method is executing in a transaction.
- JagIsRollbackOnly - Query whether
the current transaction is doomed to be rolled back or is still
viable.
- JagLockCollection - Lock a collection.
- JagLockNoWaitCollection - Lock a collection
but do not wait for a locked collection to be unlocked.
- JagLog - Write a message
to the server's log file.
- JagNewCollection - Create a
shared-data collection or return a reference to an existing collection.
- JagNewSharedData - Create a
shared variable with a specified name or retrieve the handle for
the existing variable with the specified name.
- JagNewSharedDataByIndex - Create a
shared variable with the specified index number or retrieve the
existing variable with the specified index.
- JagResultsPassthrough - Forward results
from an ODBC or Client-Library remote database command
to the client.
- JagRollbackWork - Indicate
that the component cannot complete its work for the current transaction.
The component instance will be deactivated when the method returns.
- JagSendData - Send one
row in a result set.
- JagSendMsg - Send an error
message to the calling client application from a C or C++ component.
- JagSetInstanceData - Associate
a reference to instance data with the current C component instance.
- JagSetSharedValue - Set a shared
variable value.
- JagSleep - Suspend execution
of the thread in which your component is running.
- JagUnlockCollection - Unlock a
collection.
Routines for managing component instance data
These routines manage instance data in C components (see "Components
that Require Instance Specific Data" in the EAServer
Programmer's Guide for more information).
Routines for managing transaction flow
A component that participates in transactions can call these
routines to influence the outcome of the current transaction. See "Understanding Transactions
and Component Lifecycle Models" in the EAServer Programmer's
Guide for more information.
- JagCompleteWork - Indicate
that the component's work for the current transaction was
successfully finished and that this component instance should be
deactivated when the method returns.
- JagContinueWork - Indicate
that the component should not be deactivated after the current method
invocation; allow the current transaction to be committed if the
component instance is deactivated.
- JagDisallowCommit - Indicate
that the current transaction cannot be committed because the component's
work has not been completed; the instance remains active after the
current method returns.
- JagInTransaction - Determine
whether the current method is executing in a transaction.
- JagIsRollbackOnly - Query whether
the current transaction is doomed to be rolled back or is still
viable.
- JagRollbackWork - Indicate
that the component cannot complete its work for the current transaction.
The component instance will be deactivated when the method returns.
Routines for sharing data between components
These routines allow C or C++ components
to share data. See "Share Data Between C Components" in
the EAServer Programmer's Guide for
more information.
Routines for managing cached connections
For an overview of connection management, see "Using
Connection Management" in the EAServer Programmer's
Guide.
EAServer provides the following routines to manage cached
connections:
- JagCmCacheProps - Retrieve
connection cache properties.
- JagCmGetCachebyName - Retrieve
the handle for the cache with the specified name.
- JagCmGetCachebyUser - Retrieve
a cache handle for connections that use a specified set of values
for server, user name, password, and connectivity library.
- JagCmGetConnection - Retrieve
a connection from a specified cache or from any cache that matches
a specified set of values for server, user name, password, and connectivity
library.
- JagCmGetCtx - Obtain the
connectivity-library-specific context reference that is used to
allocate cached connections in a cache.
- JagCmGetProxyConnection - Retrieve
a cached connection, specifying an alternate login name to set-proxy
to.
- JagCmReleaseConnection - Place a connection
back in the cache for reuse.
Routines for sending result sets
For information on how these routines are used to send results,
see "Sending Result Sets with C or C++" in
the EAServer Programmer's Guide.
- JagBeginResults - Begin the
sequence of calls that sends a result set to the client.
- JagBindCol - Bind a memory
address to a column in a result set.
- JagColAttributes - Specify additional
metadata for a column to be sent in a result set.
- JagDescribeCol - Describe
a column to be sent as part of a result set.
- JagEndResults - Indicate
that all rows in a result set have been sent.
- JagResultsPassthrough - Forward results
from an ODBC or Client-Library remote database command to the client.
- JagSendData - Send one
row in a result set.
Routines for handling errors in C or C++ components
These routines are useful for handling errors in C components.
See "Handle Errors in Your C Component" in the EAServer
Programmer's Guide for more information.
- JagSendMsg - Send an error
message to the calling client application from a C component.
- JagLog - Write a message
to the server's log file.
Routines for managing memory in C or C++ components
Routines to obtain user login information
You can call these routines in C or C++ component
code to obtain information about the client connection that is associated
with the current instance:
- JagGetHostName - Retrieve
the client host name for the client connection that is associated
with a C or C++ component instance.
- JagGetPassword - Retrieve
the password for the client connection that is associated with a
C or C++ component instance.
- JagGetPeerAddress - Retrieve
the client host IP address for the client connection that is associated
with a C or C++ component instance.
- JagGetUserName - Retrieve
the user name for the client connection that is associated with
a C or C++ component instance.
|
Copyright © 2001 Sybase, Inc. All rights reserved.
|
|