public interface Ddeml extends StdCallLibrary
Bindings for the DDEML - Dynamic Data Exchange Management Library (DDEML)
| Modifier and Type | Interface and Description |
|---|---|
static class |
Ddeml.CONVCONTEXT
The following structure is used by
DdeConnect(int, com.sun.jna.platform.win32.Ddeml.HSZ, com.sun.jna.platform.win32.Ddeml.HSZ, com.sun.jna.platform.win32.Ddeml.CONVCONTEXT) and DdeConnectList(int, com.sun.jna.platform.win32.Ddeml.HSZ, com.sun.jna.platform.win32.Ddeml.HSZ, com.sun.jna.platform.win32.Ddeml.HCONVLIST, com.sun.jna.platform.win32.Ddeml.CONVCONTEXT) and
by XTYP_CONNECT and XTYP_WILDCONNECT callbacks. |
static class |
Ddeml.CONVINFO
Contains information about a Dynamic Data Exchange (DDE) conversation.
|
static interface |
Ddeml.DdeCallback |
static class |
Ddeml.DDEML_MSG_HOOK_DATA |
static class |
Ddeml.HCONV |
static class |
Ddeml.HCONVLIST |
static class |
Ddeml.HDDEDATA |
static class |
Ddeml.HSZ |
static class |
Ddeml.HSZPAIR
The following structure is for use with
XTYP_WILDCONNECT processing. |
static class |
Ddeml.MONCBSTRUCT
Contains information about the current Dynamic Data Exchange (DDE)
transaction.
|
static class |
Ddeml.MONCONVSTRUCT
Contains information about a Dynamic Data Exchange (DDE) conversation.
|
static class |
Ddeml.MONERRSTRUCT
Contains information about the current Dynamic Data Exchange (DDE) error.
|
static class |
Ddeml.MONHSZSTRUCT
Contains information about a Dynamic Data Exchange (DDE) string handle.
|
static class |
Ddeml.MONLINKSTRUCT
Contains information about a Dynamic Data Exchange (DDE) advise loop.
|
static class |
Ddeml.MONMSGSTRUCT |
StdCallLibrary.StdCallCallbackLibrary.Handler| Modifier and Type | Field and Description |
|---|---|
static int |
APPCLASS_MASK |
static int |
APPCLASS_MONITOR
Makes it possible for the application to monitor DDE activity in the
system.
|
static int |
APPCLASS_STANDARD
Registers the application as a standard (nonmonitoring) DDEML
application.
|
static int |
APPCMD_CLIENTONLY
Prevents the application from becoming a server in a DDE conversation.
|
static int |
APPCMD_FILTERINITS
Prevents the DDEML from sending
XTYP_CONNECT and XTYP_WILDCONNECT
transactions to the application until the application has created its
string handles and registered its service names or has turned off
filtering by a subsequent call to the DdeNameService(int, com.sun.jna.platform.win32.Ddeml.HSZ, com.sun.jna.platform.win32.Ddeml.HSZ, int) or DdeInitialize(com.sun.jna.platform.win32.WinDef.DWORDByReference, com.sun.jna.platform.win32.Ddeml.DdeCallback, int, int)
function. |
static int |
APPCMD_MASK |
static int |
CADV_LATEACK |
static int |
CBF_FAIL_ADVISES
Prevents the callback function from receiving
XTYP_ADVSTART and
XTYP_ADVSTOP transactions. |
static int |
CBF_FAIL_ALLSVRXACTIONS
Prevents the callback function from receiving server transactions.
|
static int |
CBF_FAIL_CONNECTIONS
Prevents the callback function from receiving
XTYP_CONNECT and
XTYP_WILDCONNECT transactions. |
static int |
CBF_FAIL_EXECUTES
Prevents the callback function from receiving
XTYP_EXECUTE transactions. |
static int |
CBF_FAIL_POKES
Prevents the callback function from receiving
XTYP_POKE transactions. |
static int |
CBF_FAIL_REQUESTS
Prevents the callback function from receiving
XTYP_REQUEST transactions. |
static int |
CBF_FAIL_SELFCONNECTIONS
Prevents the callback function from receiving
XTYP_CONNECT transactions
from the application's own instance. |
static int |
CBF_SKIP_ALLNOTIFICATIONS
Prevents the callback function from receiving any notifications.
|
static int |
CBF_SKIP_CONNECT_CONFIRMS
Prevents the callback function from receiving
XTYP_CONNECT_CONFIRM
notifications. |
static int |
CBF_SKIP_DISCONNECTS
Prevents the callback function from receiving
XTYP_DISCONNECT
notifications. |
static int |
CBF_SKIP_REGISTRATIONS
Prevents the callback function from receiving
XTYP_REGISTER
notifications. |
static int |
CBF_SKIP_UNREGISTRATIONS
Prevents the callback function from receiving
XTYP_UNREGISTER
notifications. |
static int |
CP_WINANSI
default codepage for windows & old DDE convs.
|
static int |
CP_WINNEUTRAL |
static int |
CP_WINUNICODE
default codepage for usage from java
|
static int |
DDE_FACK |
static int |
DDE_FACKREQ |
static int |
DDE_FACKRESERVED |
static int |
DDE_FADVRESERVED |
static int |
DDE_FAPPSTATUS |
static int |
DDE_FBUSY |
static int |
DDE_FDATRESERVED |
static int |
DDE_FDEFERUPD |
static int |
DDE_FNOTPROCESSED |
static int |
DDE_FPOKRESERVED |
static int |
DDE_FRELEASE |
static int |
DDE_FREQUESTED |
static int |
DMLERR_ADVACKTIMEOUT
A request for a synchronous advise transaction has timed out.
|
static int |
DMLERR_BUSY
The response to the transaction caused the
DDE_FBUSY flag to be set. |
static int |
DMLERR_DATAACKTIMEOUT
A request for a synchronous data transaction has timed out.
|
static int |
DMLERR_DLL_NOT_INITIALIZED
A DDEML function was called without first calling the
DdeInitialize(com.sun.jna.platform.win32.WinDef.DWORDByReference, com.sun.jna.platform.win32.Ddeml.DdeCallback, int, int)
function, or an invalid instance identifier was passed to a DDEML
function. |
static int |
DMLERR_DLL_USAGE
An application initialized as
APPCLASS_MONITOR has attempted to perform a
DDE transaction, or an application initialized as APPCMD_CLIENTONLY has
attempted to perform server transactions. |
static int |
DMLERR_EXECACKTIMEOUT
A request for a synchronous execute transaction has timed out.
|
static int |
DMLERR_FIRST |
static int |
DMLERR_INVALIDPARAMETER
A parameter failed to be validated by the DDEML.
|
static int |
DMLERR_LAST |
static int |
DMLERR_LOW_MEMORY
A DDEML application has created a prolonged race condition (in which the
server application outruns the client), causing large amounts of memory
to be consumed.
|
static int |
DMLERR_MEMORY_ERROR
A memory allocation has failed.
|
static int |
DMLERR_NO_CONV_ESTABLISHED
A client's attempt to establish a conversation has failed.
|
static int |
DMLERR_NO_ERROR |
static int |
DMLERR_NOTPROCESSED
A transaction has failed.
|
static int |
DMLERR_POKEACKTIMEOUT
A request for a synchronous poke transaction has timed out.
|
static int |
DMLERR_POSTMSG_FAILED
An internal call to the PostMessage function has failed.
|
static int |
DMLERR_REENTRANCY
An application instance with a synchronous transaction already in
progress attempted to initiate another synchronous transaction, or the
DdeEnableCallback(int, com.sun.jna.platform.win32.Ddeml.HCONV, int) function was called from within a DDEML callback
function. |
static int |
DMLERR_SERVER_DIED
A server-side transaction was attempted on a conversation terminated by
the client, or the server terminated before completing a transaction.
|
static int |
DMLERR_SYS_ERROR
An internal error has occurred in the DDEML.
|
static int |
DMLERR_UNADVACKTIMEOUT
A request to end an advise transaction has timed out.
|
static int |
DMLERR_UNFOUND_QUEUE_ID
An invalid transaction identifier was passed to a DDEML function.
|
static int |
DNS_FILTEROFF |
static int |
DNS_FILTERON |
static int |
DNS_REGISTER |
static int |
DNS_UNREGISTER |
static int |
EC_DISABLE |
static int |
EC_ENABLEALL |
static int |
EC_ENABLEONE |
static int |
EC_QUERYWAITING |
static int |
HDATA_APPOWNED |
static Ddeml |
INSTANCE |
static int |
MF_CALLBACKS
Notifies the callback function whenever a transaction is sent to any DDE
callback function in the system.
|
static int |
MF_CONV
Notifies the callback function whenever a conversation is established or
terminated.
|
static int |
MF_ERRORS
Notifies the callback function whenever a DDE error occurs.
|
static int |
MF_HSZ_INFO
Notifies the callback function whenever a DDE application creates, frees,
or increments the usage count of a string handle or whenever a string
handle is freed as a result of a call to the
DdeUninitialize(int)
function. |
static int |
MF_LINKS
Notifies the callback function whenever an advise loop is started or
ended.
|
static int |
MF_MASK |
static int |
MF_POSTMSGS
Notifies the callback function whenever the system or an application
posts a DDE message.
|
static int |
MF_SENDMSGS
Notifies the callback function whenever the system or an application
sends a DDE message.
|
static int |
MSGF_DDEMGR |
static int |
QID_SYNC
Pseudo Transaction ID constant for the synchronous transaction
|
static int |
ST_ADVISE |
static int |
ST_BLOCKED |
static int |
ST_BLOCKNEXT |
static int |
ST_CLIENT |
static int |
ST_CONNECTED |
static int |
ST_INLIST |
static int |
ST_ISLOCAL |
static int |
ST_ISSELF |
static int |
ST_TERMINATED |
static java.lang.String |
SZDDE_ITEM_ITEMLIST |
static java.lang.String |
SZDDESYS_ITEM_FORMATS |
static java.lang.String |
SZDDESYS_ITEM_HELP |
static java.lang.String |
SZDDESYS_ITEM_RTNMSG |
static java.lang.String |
SZDDESYS_ITEM_STATUS |
static java.lang.String |
SZDDESYS_ITEM_SYSITEMS |
static java.lang.String |
SZDDESYS_ITEM_TOPICS |
static java.lang.String |
SZDDESYS_TOPIC |
static int |
TIMEOUT_ASYNC
Timeout constants for asynchronous requests
|
static int |
XCLASS_BOOL |
static int |
XCLASS_DATA |
static int |
XCLASS_FLAGS |
static int |
XCLASS_MASK |
static int |
XCLASS_NOTIFICATION |
static int |
XST_ADVACKRCVD |
static int |
XST_ADVDATAACKRCVD |
static int |
XST_ADVDATASENT |
static int |
XST_ADVSENT |
static int |
XST_CONNECTED |
static int |
XST_DATARCVD |
static int |
XST_EXECACKRCVD |
static int |
XST_EXECSENT |
static int |
XST_INCOMPLETE |
static int |
XST_INIT1 |
static int |
XST_INIT2 |
static int |
XST_NULL |
static int |
XST_POKEACKRCVD |
static int |
XST_POKESENT |
static int |
XST_REQSENT |
static int |
XST_UNADVACKRCVD |
static int |
XST_UNADVSENT |
static int |
XTYP_ADVDATA
Informs the client that the value of the data item has changed.
|
static int |
XTYP_ADVREQ
The XTYP_ADVREQ transaction informs the server that an advise transaction
is outstanding on the specified topic name and item name pair and that
data corresponding to the topic name and item name pair has changed.
|
static int |
XTYP_ADVSTART
A client uses the XTYP_ADVSTART transaction to establish an advise loop
with a server.
|
static int |
XTYP_ADVSTOP
A client uses the XTYP_ADVSTOP transaction to end an advise loop with a
server.
|
static int |
XTYP_CONNECT
A client uses the XTYP_CONNECT transaction to establish a conversation.
|
static int |
XTYP_CONNECT_CONFIRM
A Dynamic Data Exchange (DDE) server callback function, DdeCallback,
receives the XTYP_CONNECT_CONFIRM transaction to confirm that a
conversation has been established with a client and to provide the server
with the conversation handle.
|
static int |
XTYP_DISCONNECT
An application's Dynamic Data Exchange (DDE) callback function,
DdeCallback, receives the XTYP_DISCONNECT transaction when the
application's partner in a conversation uses the
DdeDisconnect(com.sun.jna.platform.win32.Ddeml.HCONV) function
to terminate the conversation. |
static int |
XTYP_ERROR
A Dynamic Data Exchange (DDE) callback function, DdeCallback, receives
the XTYP_ERROR transaction when a critical error occurs.
|
static int |
XTYP_EXECUTE
A client uses the XTYP_EXECUTE transaction to send a command string to
the server.
|
static int |
XTYP_MASK |
static int |
XTYP_MONITOR
A Dynamic Data Exchange (DDE) debugger's DDE callback function,
DdeCallback, receives the XTYP_MONITOR transaction whenever a DDE event
occurs in the system.
|
static int |
XTYP_POKE
A client uses the XTYP_POKE transaction to send unsolicited data to the
server.
|
static int |
XTYP_REGISTER
A Dynamic Data Exchange (DDE) callback function, DdeCallback, receives
the XTYP_REGISTER transaction type whenever a Dynamic Data Exchange
Management Library (DDEML) server application uses the
DdeNameService(int, com.sun.jna.platform.win32.Ddeml.HSZ, com.sun.jna.platform.win32.Ddeml.HSZ, int)
function to register a service name, or whenever a non-DDEML application
that supports the System topic is started. |
static int |
XTYP_REQUEST
A client uses the XTYP_REQUEST transaction to request data from a server.
|
static int |
XTYP_SHIFT |
static int |
XTYP_UNREGISTER
A Dynamic Data Exchange (DDE) callback function, DdeCallback, receives
the XTYP_UNREGISTER transaction whenever a Dynamic Data Exchange
Management Library (DDEML) server application uses the
DdeNameService(int, com.sun.jna.platform.win32.Ddeml.HSZ, com.sun.jna.platform.win32.Ddeml.HSZ, int)
function to unregister a service name, or whenever a non-DDEML
application that supports the System topic is terminated. |
static int |
XTYP_WILDCONNECT
Enables a client to establish a conversation on each of the server's
service name and topic name pairs that match the specified service name
and topic name.
|
static int |
XTYP_XACT_COMPLETE
A Dynamic Data Exchange (DDE) client callback function, DdeCallback,
receives the XTYP_XACT_COMPLETE transaction when an asynchronous
transaction, initiated by a call to the
DdeClientTransaction(com.sun.jna.Pointer, int, com.sun.jna.platform.win32.Ddeml.HCONV, com.sun.jna.platform.win32.Ddeml.HSZ, int, int, int, com.sun.jna.platform.win32.WinDef.DWORDByReference) function,
has completed. |
static int |
XTYPF_ACKREQ |
static int |
XTYPF_NOBLOCK |
static int |
XTYPF_NODATA |
FUNCTION_MAPPER, STDCALL_CONVENTIONOPTION_ALLOW_OBJECTS, OPTION_CALLING_CONVENTION, OPTION_CLASSLOADER, OPTION_FUNCTION_MAPPER, OPTION_INVOCATION_MAPPER, OPTION_OPEN_FLAGS, OPTION_STRING_ENCODING, OPTION_STRUCTURE_ALIGNMENT, OPTION_TYPE_MAPPER| Modifier and Type | Method and Description |
|---|---|
boolean |
DdeAbandonTransaction(int idInst,
Ddeml.HCONV hConv,
int idTransaction)
Abandons the specified asynchronous transaction and releases all
resources associated with the transaction.
|
Pointer |
DdeAccessData(Ddeml.HDDEDATA hData,
WinDef.DWORDByReference pcbDataSize)
Provides access to the data in the specified Dynamic Data Exchange (DDE) object.
|
Ddeml.HDDEDATA |
DdeAddData(Ddeml.HDDEDATA hData,
Pointer pSrc,
int cb,
int cbOff)
Adds data to the specified Dynamic Data Exchange (DDE) object.
|
Ddeml.HDDEDATA |
DdeClientTransaction(Pointer pData,
int cbData,
Ddeml.HCONV hConv,
Ddeml.HSZ hszItem,
int wFmt,
int wType,
int dwTimeout,
WinDef.DWORDByReference pdwResult)
Begins a data transaction between a client and a server.
|
Ddeml.HCONV |
DdeConnect(int idInst,
Ddeml.HSZ hszService,
Ddeml.HSZ hszTopic,
Ddeml.CONVCONTEXT pCC)
Establishes a conversation with a server application that supports the
specified service name and topic name pair.
|
Ddeml.HCONVLIST |
DdeConnectList(int idInst,
Ddeml.HSZ hszService,
Ddeml.HSZ hszTopic,
Ddeml.HCONVLIST hConvList,
Ddeml.CONVCONTEXT pCC)
Establishes a conversation with all server applications that support the
specified service name and topic name pair.
|
Ddeml.HDDEDATA |
DdeCreateDataHandle(int idInst,
Pointer pSrc,
int cb,
int cbOff,
Ddeml.HSZ hszItem,
int wFmt,
int afCmd)
Creates a Dynamic Data Exchange (DDE) object and fills the object with
data from the specified buffer.
|
Ddeml.HSZ |
DdeCreateStringHandle(int idInst,
java.lang.String psz,
int iCodePage)
Creates a handle that identifies the specified string.
|
boolean |
DdeDisconnect(Ddeml.HCONV hConv)
Terminates a conversation started by either the
DdeConnect(int, com.sun.jna.platform.win32.Ddeml.HSZ, com.sun.jna.platform.win32.Ddeml.HSZ, com.sun.jna.platform.win32.Ddeml.CONVCONTEXT) or
DdeConnectList(int, com.sun.jna.platform.win32.Ddeml.HSZ, com.sun.jna.platform.win32.Ddeml.HSZ, com.sun.jna.platform.win32.Ddeml.HCONVLIST, com.sun.jna.platform.win32.Ddeml.CONVCONTEXT) function and invalidates the specified conversation
handle. |
boolean |
DdeDisconnectList(Ddeml.HCONVLIST hConvList)
Destroys the specified conversation list and terminates all
conversations associated with the list.
|
boolean |
DdeEnableCallback(int idInst,
Ddeml.HCONV hConv,
int wCmd)
Enables or disables transactions for a specific conversation or for all
conversations currently established by the calling application.
|
boolean |
DdeFreeDataHandle(Ddeml.HDDEDATA hData)
Frees a Dynamic Data Exchange (DDE) object and deletes the data handle
associated with the object.
|
boolean |
DdeFreeStringHandle(int idInst,
Ddeml.HSZ hsz)
Frees a string handle in the calling application.
|
int |
DdeGetData(Ddeml.HDDEDATA hData,
Pointer pDst,
int cbMax,
int cbOff)
Copies data from the specified Dynamic Data Exchange (DDE) object to
the specified local buffer.
|
int |
DdeGetLastError(int idInst) |
boolean |
DdeImpersonateClient(Ddeml.HCONV hConv)
Impersonates a Dynamic Data Exchange (DDE) client application in a DDE
client conversation.
|
int |
DdeInitialize(WinDef.DWORDByReference pidInst,
Ddeml.DdeCallback fnCallback,
int afCmd,
int ulRes)
Registers an application with the Dynamic Data Exchange Management
Library (DDEML).
|
boolean |
DdeKeepStringHandle(int idInst,
Ddeml.HSZ hsz)
Increments the usage count associated with the specified handle.
|
Ddeml.HDDEDATA |
DdeNameService(int idInst,
Ddeml.HSZ hsz1,
Ddeml.HSZ hsz2,
int afCmd)
Registers or unregisters the service names a Dynamic Data Exchange (DDE)
server supports.
|
boolean |
DdePostAdvise(int idInst,
Ddeml.HSZ hszTopic,
Ddeml.HSZ hszItem)
Causes the system to send an
XTYP_ADVREQ transaction to the calling
(server) application's Dynamic Data Exchange (DDE) callback function for
each client with an active advise loop on the specified topic and item. |
int |
DdeQueryConvInfo(Ddeml.HCONV hConv,
int idTransaction,
Ddeml.CONVINFO pConvInfo)
Retrieves information about a Dynamic Data Exchange (DDE) transaction and about the conversation in which the transaction takes place.
|
Ddeml.HCONV |
DdeQueryNextServer(Ddeml.HCONVLIST hConvList,
Ddeml.HCONV hConvPrev)
Retrieves the next conversation handle in the specified conversation list.
|
int |
DdeQueryString(int idInst,
Ddeml.HSZ hsz,
Pointer psz,
int cchMax,
int iCodePage)
Copies text associated with a string handle into a buffer.
|
Ddeml.HCONV |
DdeReconnect(Ddeml.HCONV hConv)
Enables a client Dynamic Data Exchange Management Library (DDEML)
application to attempt to reestablish a conversation with a service that
has terminated a conversation with the client.
|
boolean |
DdeSetUserHandle(Ddeml.HCONV hConv,
int id,
BaseTSD.DWORD_PTR hUser)
Associates an application-defined value with a conversation handle or a
transaction identifier.
|
boolean |
DdeUnaccessData(Ddeml.HDDEDATA hData)
Unaccesses a Dynamic Data Exchange (DDE) object.
|
boolean |
DdeUninitialize(int idInst)
Frees all Dynamic Data Exchange Management Library (DDEML) resources
associated with the calling application.
|
static final Ddeml INSTANCE
static final int XST_NULL
static final int XST_INCOMPLETE
static final int XST_CONNECTED
static final int XST_INIT1
static final int XST_INIT2
static final int XST_REQSENT
static final int XST_DATARCVD
static final int XST_POKESENT
static final int XST_POKEACKRCVD
static final int XST_EXECSENT
static final int XST_EXECACKRCVD
static final int XST_ADVSENT
static final int XST_UNADVSENT
static final int XST_ADVACKRCVD
static final int XST_UNADVACKRCVD
static final int XST_ADVDATASENT
static final int XST_ADVDATAACKRCVD
static final int CADV_LATEACK
static final int ST_CONNECTED
static final int ST_ADVISE
static final int ST_ISLOCAL
static final int ST_BLOCKED
static final int ST_CLIENT
static final int ST_TERMINATED
static final int ST_INLIST
static final int ST_BLOCKNEXT
static final int ST_ISSELF
static final int DDE_FACK
static final int DDE_FBUSY
static final int DDE_FDEFERUPD
static final int DDE_FACKREQ
static final int DDE_FRELEASE
static final int DDE_FREQUESTED
static final int DDE_FAPPSTATUS
static final int DDE_FNOTPROCESSED
static final int DDE_FACKRESERVED
static final int DDE_FADVRESERVED
static final int DDE_FDATRESERVED
static final int DDE_FPOKRESERVED
static final int MSGF_DDEMGR
static final int CP_WINANSI
static final int CP_WINUNICODE
static final int CP_WINNEUTRAL
static final int XTYPF_NOBLOCK
static final int XTYPF_NODATA
static final int XTYPF_ACKREQ
static final int XCLASS_MASK
static final int XCLASS_BOOL
static final int XCLASS_DATA
static final int XCLASS_FLAGS
static final int XCLASS_NOTIFICATION
static final int XTYP_ERROR
Used Parameters
| Value | Meaning |
|---|---|
| DMLERR_LOW_MEMORY | Memory is low; advise, poke, or execute data may be lost, or the system may fail. |
Remarks
An application cannot block this transaction type; the CBR_BLOCK return code is ignored. The Dynamic Data Exchange Management Library (DDEML) attempts to free memory by removing noncritical resources. An application that has blocked conversations should unblock them.
static final int XTYP_ADVDATA
Used Parameters
XTYPF_NODATA flag when it requested the advise loop.Return value
A DDE callback function should return DDE_FACK if it processes this
transaction, DDE_FBUSY if it is too busy to process this transaction, or
DDE_FNOTPROCESSED if it rejects this transaction.
Remarks
An application must not free the data handle obtained during this
transaction. An application must, however, copy the data associated with
the data handle if the application must process the data after the
callback function returns. An application can use the DdeGetData(com.sun.jna.platform.win32.Ddeml.HDDEDATA, com.sun.jna.Pointer, int, int) function
to copy the data.
static final int XTYP_ADVREQ
DdePostAdvise(int, com.sun.jna.platform.win32.Ddeml.HSZ, com.sun.jna.platform.win32.Ddeml.HSZ) function.
Used Parameters
DdePostAdvise(int, com.sun.jna.platform.win32.Ddeml.HSZ, com.sun.jna.platform.win32.Ddeml.HSZ) function. The count is zero if the current XTYP_ADVREQ
transaction is the last one. A server can use this count to determine
whether to create an HDATA_APPOWNED data handle to the advise data.
CADV_LATEACK if the DDEML issued the
XTYP_ADVREQ transaction because of a late-arriving DDE_ACK message from a
client being outrun by the server.
Return value
The server should first call the DdeCreateDataHandle(int, com.sun.jna.Pointer, int, int, com.sun.jna.platform.win32.Ddeml.HSZ, int, int) function to create a
data handle that identifies the changed data and then return the handle.
The server should return NULL if it is unable to complete the
transaction.
Remarks
A server cannot block this transaction type; the CBR_BLOCK return code is ignored.
static final int XTYP_ADVSTART
DdeClientTransaction(com.sun.jna.Pointer, int, com.sun.jna.platform.win32.Ddeml.HCONV, com.sun.jna.platform.win32.Ddeml.HSZ, int, int, int, com.sun.jna.platform.win32.WinDef.DWORDByReference)
function.
Used Parameters
Return value
A server callback function should return TRUE to allow an advise loop on
the specified topic name and item name pair, or FALSE to deny the advise
loop. If the callback function returns TRUE, any subsequent calls to the
DdePostAdvise(int, com.sun.jna.platform.win32.Ddeml.HSZ, com.sun.jna.platform.win32.Ddeml.HSZ) function by the server on the same topic name and item name
pair causes the system to send XTYP_ADVREQ transactions to the server.
Remarks
If a client requests an advise loop on a topic name, item name, and data
format for an advise loop that is already established, the Dynamic Data
Exchange Management Library (DDEML) does not create a duplicate advise
loop but instead alters the advise loop flags (XTYPF_ACKREQ and
XTYPF_NODATA) to match the latest request.
This transaction is filtered if the server application specified the
CBF_FAIL_ADVISES flag in the DdeInitialize(com.sun.jna.platform.win32.WinDef.DWORDByReference, com.sun.jna.platform.win32.Ddeml.DdeCallback, int, int) function.
static final int XTYP_ADVSTOP
DdeClientTransaction(com.sun.jna.Pointer, int, com.sun.jna.platform.win32.Ddeml.HCONV, com.sun.jna.platform.win32.Ddeml.HSZ, int, int, int, com.sun.jna.platform.win32.WinDef.DWORDByReference) function.
Used Parameters
Remarks
This transaction is filtered if the server application specified the
CBF_FAIL_ADVISES flag in the DdeInitialize(com.sun.jna.platform.win32.WinDef.DWORDByReference, com.sun.jna.platform.win32.Ddeml.DdeCallback, int, int) function.
static final int XTYP_EXECUTE
DdeClientTransaction(com.sun.jna.Pointer, int, com.sun.jna.platform.win32.Ddeml.HCONV, com.sun.jna.platform.win32.Ddeml.HSZ, int, int, int, com.sun.jna.platform.win32.WinDef.DWORDByReference) function.
Used Parameters
Return value
A server callback function should return DDE_FACK if it processes this
transaction, DDE_FBUSY if it is too busy to process this transaction, or
DDE_FNOTPROCESSED if it rejects this transaction.
Remarks
This transaction is filtered if the server application specified the
CBF_FAIL_EXECUTES flag in the DdeInitialize(com.sun.jna.platform.win32.WinDef.DWORDByReference, com.sun.jna.platform.win32.Ddeml.DdeCallback, int, int) function.
An application must free the data handle obtained during this
transaction. An application must, however, copy the command string
associated with the data handle if the application must process the
string after the callback function returns. An application can use the
DdeGetData(com.sun.jna.platform.win32.Ddeml.HDDEDATA, com.sun.jna.Pointer, int, int) function to copy the data.
Because most client applications expect a server application to perform an XTYP_EXECUTE transaction synchronously, a server should attempt to perform all processing of the XTYP_EXECUTE transaction either from within the DDE callback function or by returning the CBR_BLOCK return code. If the hdata parameter is a command that instructs the server to terminate, the server should do so after processing the XTYP_EXECUTE transaction.
static final int XTYP_CONNECT
DdeConnect(int, com.sun.jna.platform.win32.Ddeml.HSZ, com.sun.jna.platform.win32.Ddeml.HSZ, com.sun.jna.platform.win32.Ddeml.CONVCONTEXT) function.
Used Parameters
Return value
A server callback function should return TRUE to allow the client to
establish a conversation on the specified service name and topic name
pair, or the function should return FALSE to deny the conversation. If
the callback function returns TRUE and a conversation is successfully
established, the system passes the conversation handle to the server by
issuing an XTYP_CONNECT_CONFIRM transaction to the server's callback
function (unless the server specified the CBF_SKIP_CONNECT_CONFIRMS flag
in the function).
Remarks
This transaction is filtered if the server application specified the
CBF_FAIL_CONNECTIONS flag in the DdeInitialize(com.sun.jna.platform.win32.WinDef.DWORDByReference, com.sun.jna.platform.win32.Ddeml.DdeCallback, int, int) function.
A server cannot block this transaction type; the CBR_BLOCK return code is ignored.
static final int XTYP_CONNECT_CONFIRM
XTYP_CONNECT or XTYP_WILDCONNECT transaction.
Used Parameters
Remarks
This transaction is filtered if the server application specified the CBF_SKIP_CONNECT_CONFIRMS flag in the DdeInitialize(com.sun.jna.platform.win32.WinDef.DWORDByReference, com.sun.jna.platform.win32.Ddeml.DdeCallback, int, int) function.
A server cannot block this transaction type; the CBR_BLOCK return code is ignored.
static final int XTYP_XACT_COMPLETE
DdeClientTransaction(com.sun.jna.Pointer, int, com.sun.jna.platform.win32.Ddeml.HCONV, com.sun.jna.platform.win32.Ddeml.HSZ, int, int, int, com.sun.jna.platform.win32.WinDef.DWORDByReference) function,
has completed.
Used Parameters
Remarks
An application must not free the data handle obtained during this
transaction. An application must, however, copy the data associated with
the data handle if the application must process the data after the
callback function returns. An application can use the DdeGetData(com.sun.jna.platform.win32.Ddeml.HDDEDATA, com.sun.jna.Pointer, int, int) function
to copy the data.
static final int XTYP_POKE
DdeClientTransaction(com.sun.jna.Pointer, int, com.sun.jna.platform.win32.Ddeml.HCONV, com.sun.jna.platform.win32.Ddeml.HSZ, int, int, int, com.sun.jna.platform.win32.WinDef.DWORDByReference) function.
Used Parameters
Return value
A server callback function should return the DDE_FACK flag if it
processes this transaction, the DDE_FBUSY flag if it is too busy to
process this transaction, or the DDE_FNOTPROCESSED flag if it rejects
this transaction.
Remarks
This transaction is filtered if the server application specified the CBF_FAIL_POKES flag in the DdeInitialize(com.sun.jna.platform.win32.WinDef.DWORDByReference, com.sun.jna.platform.win32.Ddeml.DdeCallback, int, int) function.
static final int XTYP_REGISTER
DdeNameService(int, com.sun.jna.platform.win32.Ddeml.HSZ, com.sun.jna.platform.win32.Ddeml.HSZ, int)
function to register a service name, or whenever a non-DDEML application
that supports the System topic is started.
Used Parameters
This transaction is filtered if the application specified the
CBF_SKIP_REGISTRATIONS flag in the DdeInitialize(com.sun.jna.platform.win32.WinDef.DWORDByReference, com.sun.jna.platform.win32.Ddeml.DdeCallback, int, int) function.
A application cannot block this transaction type; the CBR_BLOCK return code is ignored.
An application should use the hsz1 parameter to add the service name to the list of servers available to the user. An application should use the hsz2 parameter to identify which application instance has started.
static final int XTYP_REQUEST
DdeClientTransaction(com.sun.jna.Pointer, int, com.sun.jna.platform.win32.Ddeml.HCONV, com.sun.jna.platform.win32.Ddeml.HSZ, int, int, int, com.sun.jna.platform.win32.WinDef.DWORDByReference) function.
Used Parameters
Return value
The server should call the DdeCreateDataHandle(int, com.sun.jna.Pointer, int, int, com.sun.jna.platform.win32.Ddeml.HSZ, int, int) function to create a data
handle that identifies the data and then return the handle. The server
should return NULL if it is unable to complete the transaction. If the
server returns NULL, the client will receive a DDE_FNOTPROCESSED
flag.
Remarks
This transaction is filtered if the server application specified the
CBF_FAIL_REQUESTS flag in the DdeInitialize(com.sun.jna.platform.win32.WinDef.DWORDByReference, com.sun.jna.platform.win32.Ddeml.DdeCallback, int, int) function.
If responding to this transaction requires lengthy processing, the server
can return the CBR_BLOCK return code to suspend future transactions on
the current conversation and then process the transaction asynchronously.
When the server has finished and the data is ready to pass to the client,
the server can call the DdeEnableCallback(int, com.sun.jna.platform.win32.Ddeml.HCONV, int) function to resume the
conversation.
static final int XTYP_DISCONNECT
DdeDisconnect(com.sun.jna.platform.win32.Ddeml.HCONV) function
to terminate the conversation.
Used Parameters
Remarks
This transaction is filtered if the application specified the
CBF_SKIP_DISCONNECTS flag in the DdeInitialize(com.sun.jna.platform.win32.WinDef.DWORDByReference, com.sun.jna.platform.win32.Ddeml.DdeCallback, int, int) function.
The application can obtain the status of the terminated conversation by
calling the DdeQueryConvInfo(com.sun.jna.platform.win32.Ddeml.HCONV, int, com.sun.jna.platform.win32.Ddeml.CONVINFO) function while processing this transaction.
The conversation handle becomes invalid after the callback function
returns.
An application cannot block this transaction type; the CBR_BLOCK return code is ignored.
static final int XTYP_UNREGISTER
DdeNameService(int, com.sun.jna.platform.win32.Ddeml.HSZ, com.sun.jna.platform.win32.Ddeml.HSZ, int)
function to unregister a service name, or whenever a non-DDEML
application that supports the System topic is terminated.
Used Parameters
Remarks
This transaction is filtered if the application specified the
CBF_SKIP_REGISTRATIONS flag in the DdeInitialize(com.sun.jna.platform.win32.WinDef.DWORDByReference, com.sun.jna.platform.win32.Ddeml.DdeCallback, int, int) function.
A application cannot block this transaction type; the CBR_BLOCK return code is ignored.
An application should use the hsz1 parameter to remove the service name from the list of servers available to the user. An application should use the hsz2 parameter to identify which application instance has terminated.
static final int XTYP_WILDCONNECT
DdeConnect(int, com.sun.jna.platform.win32.Ddeml.HSZ, com.sun.jna.platform.win32.Ddeml.HSZ, com.sun.jna.platform.win32.Ddeml.CONVCONTEXT) or
DdeConnectList(int, com.sun.jna.platform.win32.Ddeml.HSZ, com.sun.jna.platform.win32.Ddeml.HSZ, com.sun.jna.platform.win32.Ddeml.HCONVLIST, com.sun.jna.platform.win32.Ddeml.CONVCONTEXT) function.
Used Parameters
Return value
The server should return a data handle that identifies an array of
HSZPAIR structures. The array should contain one structure for each
service-name and topic-name pair that matches the service-name and
topic-name pair requested by the client. The array must be terminated by
a NULL string handle. The system sends the XTYP_CONNECT_CONFIRM
transaction to the server to confirm each conversation and to pass the
conversation handles to the server. The server will not receive these
confirmations if it specified the CBF_SKIP_CONNECT_CONFIRMS flag in the
DdeInitialize(com.sun.jna.platform.win32.WinDef.DWORDByReference, com.sun.jna.platform.win32.Ddeml.DdeCallback, int, int) function.
The server should return NULL to refuse the XTYP_WILDCONNECT transaction.
Remarks
This transaction is filtered if the server application specified the
CBF_FAIL_CONNECTIONS flag in the DdeInitialize(com.sun.jna.platform.win32.WinDef.DWORDByReference, com.sun.jna.platform.win32.Ddeml.DdeCallback, int, int) function.
A server cannot block this transaction type; the CBR_BLOCK return code is ignored.
static final int XTYP_MONITOR
APPCLASS_MONITOR value when it calls the DdeInitialize(com.sun.jna.platform.win32.WinDef.DWORDByReference, com.sun.jna.platform.win32.Ddeml.DdeCallback, int, int)
function.
Used Parameters
DdeAccessData(com.sun.jna.platform.win32.Ddeml.HDDEDATA, com.sun.jna.platform.win32.WinDef.DWORDByReference)
function to obtain a pointer to the object.| Value | Meaning |
|---|---|
MF_CALLBACKS | The system sent a transaction to a DDE callback function. The DDE object contains a MONCBSTRUCT structure that provides information about the transaction. |
MF_CONV | A DDE conversation was established or terminated. The DDE object contains a MONCONVSTRUCT structure that provides information about the conversation. |
MF_ERRORS | A DDE error occurred. The DDE object contains a MONERRSTRUCT structure that provides information about the error. |
MF_HSZ_INFO | A DDE application created, freed, or
incremented the usage count of a string handle, or a string handle was
freed as a result of a call to the DdeUninitialize(int) function. The DDE
object contains a MONHSZSTRUCT structure that provides information about
the string handle. |
MF_LINKS | A DDE application started or stopped an advise loop. The DDE object contains a MONLINKSTRUCT structure that provides information about the advise loop. |
MF_POSTMSGS | The system or an application posted a DDE message. The DDE object contains a MONMSGSTRUCT structure that provides information about the message. |
MF_SENDMSGS | The system or an application sent a DDE message. The DDE object contains a MONMSGSTRUCT structure that provides information about the message. |
Return value
If the callback function processes this transaction, it should return 0.
static final int XTYP_MASK
static final int XTYP_SHIFT
static final int TIMEOUT_ASYNC
static final int QID_SYNC
static final java.lang.String SZDDESYS_TOPIC
static final java.lang.String SZDDESYS_ITEM_TOPICS
static final java.lang.String SZDDESYS_ITEM_SYSITEMS
static final java.lang.String SZDDESYS_ITEM_RTNMSG
static final java.lang.String SZDDESYS_ITEM_STATUS
static final java.lang.String SZDDESYS_ITEM_FORMATS
static final java.lang.String SZDDESYS_ITEM_HELP
static final java.lang.String SZDDE_ITEM_ITEMLIST
static final int DMLERR_NO_ERROR
static final int DMLERR_FIRST
static final int DMLERR_ADVACKTIMEOUT
static final int DMLERR_BUSY
DDE_FBUSY flag to be set.static final int DMLERR_DATAACKTIMEOUT
static final int DMLERR_DLL_NOT_INITIALIZED
DdeInitialize(com.sun.jna.platform.win32.WinDef.DWORDByReference, com.sun.jna.platform.win32.Ddeml.DdeCallback, int, int)
function, or an invalid instance identifier was passed to a DDEML
function.static final int DMLERR_DLL_USAGE
APPCLASS_MONITOR has attempted to perform a
DDE transaction, or an application initialized as APPCMD_CLIENTONLY has
attempted to perform server transactions.static final int DMLERR_EXECACKTIMEOUT
static final int DMLERR_INVALIDPARAMETER
static final int DMLERR_LOW_MEMORY
static final int DMLERR_MEMORY_ERROR
static final int DMLERR_NOTPROCESSED
static final int DMLERR_NO_CONV_ESTABLISHED
static final int DMLERR_POKEACKTIMEOUT
static final int DMLERR_POSTMSG_FAILED
static final int DMLERR_REENTRANCY
DdeEnableCallback(int, com.sun.jna.platform.win32.Ddeml.HCONV, int) function was called from within a DDEML callback
function.static final int DMLERR_SERVER_DIED
static final int DMLERR_SYS_ERROR
static final int DMLERR_UNADVACKTIMEOUT
static final int DMLERR_UNFOUND_QUEUE_ID
XTYP_XACT_COMPLETE callback, the
transaction identifier for that callback function is no longer valid.static final int DMLERR_LAST
static final int HDATA_APPOWNED
static final int CBF_FAIL_SELFCONNECTIONS
XTYP_CONNECT transactions
from the application's own instance. This flag prevents an application
from establishing a DDE conversation with its own instance. An
application should use this flag if it needs to communicate with other
instances of itself but not with itself.static final int CBF_FAIL_CONNECTIONS
XTYP_CONNECT and
XTYP_WILDCONNECT transactions.static final int CBF_FAIL_ADVISES
XTYP_ADVSTART and
XTYP_ADVSTOP transactions. The system returns DDE_FNOTPROCESSED to each
client that sends an XTYP_ADVSTART or XTYP_ADVSTOP transaction to the
server.static final int CBF_FAIL_EXECUTES
XTYP_EXECUTE transactions.
The system returns DDE_FNOTPROCESSED to a client that sends an
XTYP_EXECUTE transaction to the server.static final int CBF_FAIL_POKES
XTYP_POKE transactions. The
system returns DDE_FNOTPROCESSED to a client that sends an XTYP_POKE
transaction to the server.static final int CBF_FAIL_REQUESTS
XTYP_REQUEST transactions.
The system returns DDE_FNOTPROCESSED to a client that sends an
XTYP_REQUEST transaction to the server.static final int CBF_FAIL_ALLSVRXACTIONS
DDE_FNOTPROCESSED to each client that sends a transaction
to this application. This flag is equivalent to combining all CBF_FAIL_
flags.static final int CBF_SKIP_CONNECT_CONFIRMS
XTYP_CONNECT_CONFIRM
notifications.static final int CBF_SKIP_REGISTRATIONS
XTYP_REGISTER
notifications.static final int CBF_SKIP_UNREGISTRATIONS
XTYP_UNREGISTER
notifications.static final int CBF_SKIP_DISCONNECTS
XTYP_DISCONNECT
notifications.static final int CBF_SKIP_ALLNOTIFICATIONS
static final int APPCMD_CLIENTONLY
CBF_FAIL_ALLSVRXACTIONSstatic final int APPCMD_FILTERINITS
XTYP_CONNECT and XTYP_WILDCONNECT
transactions to the application until the application has created its
string handles and registered its service names or has turned off
filtering by a subsequent call to the DdeNameService(int, com.sun.jna.platform.win32.Ddeml.HSZ, com.sun.jna.platform.win32.Ddeml.HSZ, int) or DdeInitialize(com.sun.jna.platform.win32.WinDef.DWORDByReference, com.sun.jna.platform.win32.Ddeml.DdeCallback, int, int)
function. This flag is always in effect when an application calls
DdeInitialize(com.sun.jna.platform.win32.WinDef.DWORDByReference, com.sun.jna.platform.win32.Ddeml.DdeCallback, int, int) for the first time, regardless of whether the application
specifies the flag. On subsequent calls to DdeInitialize(com.sun.jna.platform.win32.WinDef.DWORDByReference, com.sun.jna.platform.win32.Ddeml.DdeCallback, int, int), not specifying
this flag turns off the application's service-name filters, but
specifying it turns on the application's service name filters.static final int APPCMD_MASK
static final int APPCLASS_STANDARD
static final int APPCLASS_MONITOR
static final int APPCLASS_MASK
static final int MF_HSZ_INFO
DdeUninitialize(int)
function.static final int MF_SENDMSGS
static final int MF_POSTMSGS
static final int MF_CALLBACKS
static final int MF_ERRORS
static final int MF_LINKS
static final int MF_CONV
static final int MF_MASK
static final int EC_ENABLEALL
static final int EC_ENABLEONE
static final int EC_DISABLE
static final int EC_QUERYWAITING
static final int DNS_REGISTER
static final int DNS_UNREGISTER
static final int DNS_FILTERON
static final int DNS_FILTEROFF
int DdeInitialize(WinDef.DWORDByReference pidInst, Ddeml.DdeCallback fnCallback, int afCmd, int ulRes)
pidInst - The application instance identifier. At initialization,
this parameter should point to 0. If the function succeeds, this
parameter points to the instance identifier for the application. This
value should be passed as the idInst parameter in all other DDEML
functions that require it. If an application uses multiple instances of
the DDEML dynamic-link library (DLL), the application should provide a
different callback function for each instance.
If pidInst points to a nonzero value, reinitialization of the DDEML is implied. In this case, pidInst must point to a valid application-instance identifier.
fnCallback - A pointer to the application-defined DDE callback function.
This function processes DDE transactions sent by the system.
For more information, see the DdeCallback callback function.afCmd - A set of APPCMD_, CBF_, and MF_ flags. The APPCMD_ flags
provide special instructions to DdeInitialize. The CBF_ flags specify
filters that prevent specific types of transactions from reaching the
callback function. The MF_ flags specify the types of DDE activity that a
DDE monitoring application monitors. Using these flags enhances the
performance of a DDE application by eliminating unnecessary calls to the
callback function.
This parameter can be one or more of the following values.
| Value | Meaning |
|---|---|
|
Makes it possible for the application to monitor DDE activity in the
system. This flag is for use by DDE monitoring applications. The
application specifies the types of DDE activity to monitor by combining
one or more monitor flags with the |
|
Registers the application as a standard (nonmonitoring) DDEML application. |
|
Prevents the application from becoming a server in a DDE conversation.
The application can only be a client. This flag reduces consumption of
resources by the DDEML. It includes the functionality of the
|
|
Prevents the DDEML from sending |
|
Prevents the callback function from receiving server transactions. The
system returns |
|
Prevents the callback function from receiving |
|
Prevents the callback function from receiving |
|
Prevents the callback function from receiving |
|
Prevents the callback function from receiving |
|
Prevents the callback function from receiving |
|
Prevents the callback function from receiving |
|
Prevents the callback function from receiving any notifications. This flag is equivalent to combining all CBF_SKIP_ flags. |
|
Prevents the callback function from receiving |
|
Prevents the callback function from receiving |
|
Prevents the callback function from receiving |
|
Prevents the callback function from receiving |
|
Notifies the callback function whenever a transaction is sent to any DDE callback function in the system. |
|
Notifies the callback function whenever a conversation is established or terminated. |
|
Notifies the callback function whenever a DDE error occurs. |
|
Notifies the callback function whenever a DDE application creates, frees,
or increments the usage count of a string handle or whenever a string
handle is freed as a result of a call to the |
|
Notifies the callback function whenever an advise loop is started or ended. |
|
Notifies the callback function whenever the system or an application posts a DDE message. |
|
Notifies the callback function whenever the system or an application sends a DDE message. |
ulRes - Reserved; must be set to zero.DMLERR_NO_ERROR.
If the function fails, the return value is one of the following values:
boolean DdeUninitialize(int idInst)
idInst - The application instance identifier obtained by a previous
call to the DdeInitialize(com.sun.jna.platform.win32.WinDef.DWORDByReference, com.sun.jna.platform.win32.Ddeml.DdeCallback, int, int) function.Ddeml.HCONVLIST DdeConnectList(int idInst, Ddeml.HSZ hszService, Ddeml.HSZ hszTopic, Ddeml.HCONVLIST hConvList, Ddeml.CONVCONTEXT pCC)
idInst - The application instance identifier obtained by a previous
call to the DdeInitialize(com.sun.jna.platform.win32.WinDef.DWORDByReference, com.sun.jna.platform.win32.Ddeml.DdeCallback, int, int) function.hszService - A handle to the string that specifies the service name
of the server application with which a conversation is to be established.
If this parameter is 0L, the system attempts to establish conversations
with all available servers that support the specified topic name.hszTopic - A handle to the string that specifies the name of the
topic on which a conversation is to be established. This handle must
have been created by a previous call to the DdeCreateStringHandle(int, java.lang.String, int)
function. If this parameter is 0L, the system will attempt to establish
conversations on all topics supported by the selected server (or servers).hConvList - A handle to the conversation list to be enumerated.
This parameter should be 0L if a new conversation list is to be established.pCC - A pointer to the CONVCONTEXT structure that contains
conversation-context information. If this parameter is NULL, the server
receives the default CONVCONTEXT structure during the XTYP_CONNECT or
XTYP_WILDCONNECT transaction.If the function fails, the return value is 0L. The handle to the old conversation list is no longer valid.
The DdeGetLastError(int) function can be used to get the error code, which
can be one of the following values:
Ddeml.HCONV DdeQueryNextServer(Ddeml.HCONVLIST hConvList, Ddeml.HCONV hConvPrev)
hConvList - A handle to the conversation list. This handle must have
been created by a previous call to the DdeConnectList(int, com.sun.jna.platform.win32.Ddeml.HSZ, com.sun.jna.platform.win32.Ddeml.HSZ, com.sun.jna.platform.win32.Ddeml.HCONVLIST, com.sun.jna.platform.win32.Ddeml.CONVCONTEXT) function.hConvPrev - A handle to the conversation handle previously returned
by this function. If this parameter is 0L, the function returns the first
conversation handle in the list.boolean DdeDisconnectList(Ddeml.HCONVLIST hConvList)
hConvList - A handle to the conversation list. This handle must have
been created by a previous call to the DdeConnectList(int, com.sun.jna.platform.win32.Ddeml.HSZ, com.sun.jna.platform.win32.Ddeml.HSZ, com.sun.jna.platform.win32.Ddeml.HCONVLIST, com.sun.jna.platform.win32.Ddeml.CONVCONTEXT) function.The DdeGetLastError(int) function can be used to get the error code,
which can be one of the following values:
Ddeml.HCONV DdeConnect(int idInst, Ddeml.HSZ hszService, Ddeml.HSZ hszTopic, Ddeml.CONVCONTEXT pCC)
idInst - The application instance identifier obtained by a previous
call to the DdeInitialize(com.sun.jna.platform.win32.WinDef.DWORDByReference, com.sun.jna.platform.win32.Ddeml.DdeCallback, int, int) function.hszService - A handle to the string that specifies the service name
of the server application with which a conversation is to be established.
This handle must have been created by a previous call to the
DdeCreateStringHandle(int, java.lang.String, int) function. If this parameter is 0L, a conversation
is established with any available server.hszTopic - A handle to the string that specifies the name of the
topic on which a conversation is to be established. This handle must have
been created by a previous call to DdeCreateStringHandle(int, java.lang.String, int). If this
parameter is 0L, a conversation on any topic supported by the selected
server is established.pCC - A pointer to the CONVCONTEXT structure that contains
conversation context information. If this parameter is NULL, the server
receives the default CONVCONTEXT structure during the XTYP_CONNECT or
XTYP_WILDCONNECT transaction.If the function fails, the return value is 0L.
The DdeGetLastError(int) function can be used to get the error code, which can
be one of the following values:
boolean DdeDisconnect(Ddeml.HCONV hConv)
DdeConnect(int, com.sun.jna.platform.win32.Ddeml.HSZ, com.sun.jna.platform.win32.Ddeml.HSZ, com.sun.jna.platform.win32.Ddeml.CONVCONTEXT) or
DdeConnectList(int, com.sun.jna.platform.win32.Ddeml.HSZ, com.sun.jna.platform.win32.Ddeml.HSZ, com.sun.jna.platform.win32.Ddeml.HCONVLIST, com.sun.jna.platform.win32.Ddeml.CONVCONTEXT) function and invalidates the specified conversation
handle.hConv - A handle to the active conversation to be terminated.
The DdeGetLastError(int) function can be used to get the error code, which can
be one of the following values:
Ddeml.HCONV DdeReconnect(Ddeml.HCONV hConv)
hConv - A handle to the conversation to be reestablished. A client
must have obtained the conversation handle by a previous call to the
DdeConnect(int, com.sun.jna.platform.win32.Ddeml.HSZ, com.sun.jna.platform.win32.Ddeml.HSZ, com.sun.jna.platform.win32.Ddeml.CONVCONTEXT) function or from an XTYP_DISCONNECT transaction.If the function fails, the return value is 0L.
The DdeGetLastError(int) function can be used to get the error code, which can
be one of the following values:
int DdeQueryConvInfo(Ddeml.HCONV hConv, int idTransaction, Ddeml.CONVINFO pConvInfo)
hConv - A handle to the conversation.idTransaction - The transaction. For asynchronous transactions, this
parameter should be a transaction identifier returned by the
DdeClientTransaction(com.sun.jna.Pointer, int, com.sun.jna.platform.win32.Ddeml.HCONV, com.sun.jna.platform.win32.Ddeml.HSZ, int, int, int, com.sun.jna.platform.win32.WinDef.DWORDByReference) function. For synchronous transactions, this
parameter should be QID_SYNC.pConvInfo - A pointer to the CONVINFO structure that receives
information about the transaction and conversation. The cb member of the
CONVINFO structure must specify the length of the buffer allocated for
the structure.If the function fails, the return value is FALSE.
The DdeGetLastError(int) function can be used to get the error code, which can
be one of the following values:
boolean DdeSetUserHandle(Ddeml.HCONV hConv, int id, BaseTSD.DWORD_PTR hUser)
DdeQueryConvInfo(com.sun.jna.platform.win32.Ddeml.HCONV, int, com.sun.jna.platform.win32.Ddeml.CONVINFO)
function to retrieve this value.hConv - A handle to the conversation.id - The transaction identifier to associate with the value
specified by the hUser parameter. An application should set this
parameter to QID_SYNC to associate hUser with the conversation identified
by the hConv parameter.hUser - The value to be associated with the conversation handle.
The DdeGetLastError(int) function can be used to get the error code, which can
be one of the following values:
boolean DdeAbandonTransaction(int idInst,
Ddeml.HCONV hConv,
int idTransaction)
idInst - The application instance identifier obtained by a previous
call to the DdeInitialize(com.sun.jna.platform.win32.WinDef.DWORDByReference, com.sun.jna.platform.win32.Ddeml.DdeCallback, int, int) function.hConv - A handle to the conversation in which the transaction was
initiated. If this parameter is 0L, all transactions are abandoned (that
is, the idTransaction parameter is ignored).idTransaction - The identifier of the transaction to be abandoned.
If this parameter is 0L, all active transactions in the specified
conversation are abandoned.
The DdeGetLastError(int) function can be used to get the error code, which can
be one of the following values:
boolean DdePostAdvise(int idInst,
Ddeml.HSZ hszTopic,
Ddeml.HSZ hszItem)
XTYP_ADVREQ transaction to the calling
(server) application's Dynamic Data Exchange (DDE) callback function for
each client with an active advise loop on the specified topic and item. A
server application should call this function whenever the data associated
with the topic name or item name pair changes.idInst - The application instance identifier obtained by a previous
call to the DdeInitialize(com.sun.jna.platform.win32.WinDef.DWORDByReference, com.sun.jna.platform.win32.Ddeml.DdeCallback, int, int) function.hszTopic - A handle to a string that specifies the topic name. To
send notifications for all topics with active advise loops, an
application can set this parameter to 0L.hszItem - A handle to a string that specifies the item name. To send
notifications for all items with active advise loops, an application can
set this parameter to 0L.
The DdeGetLastError(int) function can be used to get the error code, which can
be one of the following values:
boolean DdeEnableCallback(int idInst,
Ddeml.HCONV hConv,
int wCmd)
idInst - The application-instance identifier obtained by a previous
call to the DdeInitialize(com.sun.jna.platform.win32.WinDef.DWORDByReference, com.sun.jna.platform.win32.Ddeml.DdeCallback, int, int) function.hConv - A handle to the conversation to enable or disable. If this
parameter is NULL, the function affects all conversations.wCmd - The function code. This parameter can be one of the following
values.
| Value | Meaning |
|---|---|
EC_ENABLEALL | Enables all transactions for the specified conversation. |
EC_ENABLEONE | Enables one transaction for the specified conversation. |
EC_DISABLE | Disables all blockable transactions for the
specified conversation.
A server application can disable the following transactions: A client application can disable the following transactions: |
EC_QUERYWAITING | Determines whether any transactions are in the queue for the specified conversation. |
If the function fails, the return value is zero.
If the wCmd parameter is EC_QUERYWAITING, and the application transaction
queue contains one or more unprocessed transactions that are not being
processed, the return value is TRUE; otherwise, it is FALSE.
The DdeGetLastError(int) function can be used to get the error code, which can
be one of the following values:
boolean DdeImpersonateClient(Ddeml.HCONV hConv)
hConv - A handle to the DDE client conversation to be impersonated.To get extended error information call GetLastError.
Ddeml.HDDEDATA DdeNameService(int idInst, Ddeml.HSZ hsz1, Ddeml.HSZ hsz2, int afCmd)
XTYP_REGISTER or
XTYP_UNREGISTER transactions to other running Dynamic Data Exchange
Management Library (DDEML) client applications.idInst - The application instance identifier obtained by a previous
call to the DdeInitialize(com.sun.jna.platform.win32.WinDef.DWORDByReference, com.sun.jna.platform.win32.Ddeml.DdeCallback, int, int) function.hsz1 - A handle to the string that specifies the service name the
server is registering or unregistering. An application that is
unregistering all of its service names should set this parameter to 0L.hsz2 - Reserved; should be set to 0L.afCmd - The service name options. This parameter can be one of the
following values.
| Value | Meaning |
|---|---|
DNS_REGISTER | Registers the error code service name. |
DNS_UNREGISTER | Unregisters the error code service name. If the hsz1 parameter is 0L, all service names registered by the server will be unregistered. |
DNS_FILTERON | Turns on service name initiation filtering.
The filter prevents a server from receiving XTYP_CONNECT transactions for
service names it has not registered. This is the default setting for this
filter.
If a server application does not register any service names, the application cannot receive XTYP_WILDCONNECT transactions.
|
DNS_FILTEROFF | Turns off service name initiation
filtering. If this flag is specified, the server receives an XTYP_CONNECT
transaction whenever another DDE application calls the DdeConnect(int, com.sun.jna.platform.win32.Ddeml.HSZ, com.sun.jna.platform.win32.Ddeml.HSZ, com.sun.jna.platform.win32.Ddeml.CONVCONTEXT)
function, regardless of the service name. |
If the function fails, the return value is 0L.
The DdeGetLastError(int) function can be used to get the error code, which can
be one of the following values:
Ddeml.HDDEDATA DdeClientTransaction(Pointer pData, int cbData, Ddeml.HCONV hConv, Ddeml.HSZ hszItem, int wFmt, int wType, int dwTimeout, WinDef.DWORDByReference pdwResult)
pData - The beginning of the data the client must pass to the server.
Optionally, an application can specify the data handle (HDDEDATA) to
pass to the server and in that case the cbData parameter should be set
to -1. This parameter is required only if the wType parameter is
XTYP_EXECUTE or XTYP_POKE. Otherwise, this parameter should be NULL.
For the optional usage of this parameter, XTYP_POKE transactions where
pData is a data handle, the handle must have been created by a previous
call to the DdeCreateDataHandle(int, com.sun.jna.Pointer, int, int, com.sun.jna.platform.win32.Ddeml.HSZ, int, int) function, employing the same data format
specified in the wFmt parameter.
cbData - The length, in bytes, of the data pointed to by the pData
parameter, including the terminating NULL, if the data is a string.
A value of -1 indicates that pData is a data handle that identifies the
data being sent.hConv - A handle to the conversation in which the transaction is to
take place.hszItem - A handle to the data item for which data is being
exchanged during the transaction. This handle must have been created by
a previous call to the DdeCreateStringHandle(int, java.lang.String, int) function. This parameter is
ignored (and should be set to 0L) if the wType parameter is XTYP_EXECUTE.wFmt - The standard clipboard format in which the data item is
being submitted or requested.
If the transaction specified by the wType parameter does not pass
data or is XTYP_EXECUTE, this parameter should be zero.
If the transaction specified by the wType parameter references
non-execute DDE data ( XTYP_POKE, XTYP_ADVSTART, XTYP_ADVSTOP, XTYP_REQUEST),
the wFmt value must be either a valid predefined (CF_) DDE format or a
valid registered clipboard format.
wType - The transaction type. This parameter can be one of the
following values.
| Value | Meaning |
|---|---|
XTYP_ADVSTART | Begins an advise loop. Any number of
distinct advise loops can exist within a conversation. An application can
alter the advise loop type by combining the XTYP_ADVSTART transaction
type with one or more of the following flags:
|
XTYP_ADVSTOP | Ends an advise loop. |
XTYP_EXECUTE | Begins an execute transaction. |
XTYP_POKE | Begins a poke transaction. |
XTYP_REQUEST | Begins a request transaction. |
dwTimeout - The maximum amount of time, in milliseconds, that the
client will wait for a response from the server application in a
synchronous transaction. This parameter should be TIMEOUT_ASYNC for
asynchronous transactions.pdwResult - A pointer to a variable that receives the result of the
transaction. An application that does not check the result can use NULL
for this value. For synchronous transactions, the low-order word of this
variable contains any applicable DDE_ flags resulting from the
transaction. This provides support for applications dependent on
DDE_APPSTATUS bits. It is, however, recommended that applications no
longer use these bits because they may not be supported in future
versions of the Dynamic Data Exchange Management Library (DDEML).
For asynchronous transactions, this variable is filled with a unique
transaction identifier for use with the DdeAbandonTransaction(int, com.sun.jna.platform.win32.Ddeml.HCONV, int) function
and the XTYP_XACT_COMPLETE transaction.The DdeGetLastError(int) function can be used to get the error code,
which can be one of the following values:
DMLERR_ADVACKTIMEOUTDMLERR_BUSYDMLERR_DATAACKTIMEOUTDMLERR_DLL_NOT_INITIALIZEDDMLERR_EXECACKTIMEOUTDMLERR_INVALIDPARAMETERDMLERR_MEMORY_ERRORDMLERR_NO_CONV_ESTABLISHEDDMLERR_NO_ERRORDMLERR_NOTPROCESSEDDMLERR_POKEACKTIMEOUTDMLERR_POSTMSG_FAILEDDMLERR_REENTRANCYDMLERR_SERVER_DIEDDMLERR_UNADVACKTIMEOUTDdeml.HDDEDATA DdeCreateDataHandle(int idInst, Pointer pSrc, int cb, int cbOff, Ddeml.HSZ hszItem, int wFmt, int afCmd)
idInst - The application instance identifier obtained by a previous
call to the DdeInitialize(com.sun.jna.platform.win32.WinDef.DWORDByReference, com.sun.jna.platform.win32.Ddeml.DdeCallback, int, int) function.pSrc - The data to be copied to the DDE object. If this parameter
is NULL, no data is copied to the object.cb - The amount of memory, in bytes, to copy from the buffer pointed
to by pSrc. (include the terminating NULL, if the data is a string).
If this parameter is zero, the pSrc parameter is ignored.cbOff - An offset, in bytes, from the beginning of the buffer
pointed to by the pSrc parameter. The data beginning at this offset is
copied from the buffer to the DDE object.hszItem - A handle to the string that specifies the data item
corresponding to the DDE object. This handle must have been created by a
previous call to the DdeCreateStringHandle(int, java.lang.String, int) function. If the data handle
is to be used in an XTYP_EXECUTE transaction, this parameter must be 0L.wFmt - The standard clipboard format of the data.afCmd - The creation flags. This parameter can be HDATA_APPOWNED,
which specifies that the server application calling the
DdeCreateDataHandle function owns the data handle this function creates.
This flag enables the application to share the data handle with other
DDEML applications rather than creating a separate handle to pass to each
application. If this flag is specified, the application must eventually
free the shared memory object associated with the handle by using the
DdeFreeDataHandle(com.sun.jna.platform.win32.Ddeml.HDDEDATA) function. If this flag is not specified, the handle
becomes invalid in the application that created the handle after the
data handle is returned by the application's DDE callback function or
is used as a parameter in another DDEML function.If the function fails, the return value is 0L.
The DdeGetLastError(int) function can be used to get the error code,
which can be one of the following values:
Ddeml.HDDEDATA DdeAddData(Ddeml.HDDEDATA hData, Pointer pSrc, int cb, int cbOff)
hData - A handle to the DDE object that receives additional data.pSrc - The data to be added to the DDE object.cb - The length, in bytes, of the data to be added to the DDE
object, including the terminating NULL, if the data is a string.cbOff - An offset, in bytes, from the beginning of the DDE object.
The additional data is copied to the object beginning at this offset.If the function fails, the return value is zero.
The DdeGetLastError(int) function can be used to get the error code, which
can be one of the following values:
int DdeGetData(Ddeml.HDDEDATA hData, Pointer pDst, int cbMax, int cbOff)
hData - A handle to the DDE object that contains the data to copy.pDst - A pointer to the buffer that receives the data. If this
parameter is NULL, the DdeGetData function returns the amount of data,
in bytes, that would be copied to the buffer.cbMax - The maximum amount of data, in bytes, to copy to the buffer
pointed to by the pDst parameter. Typically, this parameter specifies
the length of the buffer pointed to by pDst.cbOff - An offset within the DDE object. Data is copied from the
object beginning at this offset.If the pDst parameter is NULL, the return value is the size, in bytes, of the memory object associated with the data handle.
The DdeGetLastError(int) function can be used to get the error code, which
can be one of the following values:
Pointer DdeAccessData(Ddeml.HDDEDATA hData, WinDef.DWORDByReference pcbDataSize)
DdeUnaccessData(com.sun.jna.platform.win32.Ddeml.HDDEDATA) function when it has
finished accessing the data in the object.hData - A handle to the DDE object to be accessed.pcbDataSize - A pointer to a variable that receives the size, in
bytes, of the DDE object identified by the hData parameter. If this
parameter is NULL, no size information is returned.If the function fails, the return value is NULL.
The DdeGetLastError(int) function can be used to get the error code, which can
be one of the following values:
boolean DdeUnaccessData(Ddeml.HDDEDATA hData)
hData - A handle to the DDE object.The DdeGetLastError(int) function can be used to get the error code, which
can be one of the following values:
boolean DdeFreeDataHandle(Ddeml.HDDEDATA hData)
hData - A handle to the DDE object to be freed. This handle must
have been created by a previous call to the DdeCreateDataHandle(int, com.sun.jna.Pointer, int, int, com.sun.jna.platform.win32.Ddeml.HSZ, int, int) function
or returned by the DdeClientTransaction(com.sun.jna.Pointer, int, com.sun.jna.platform.win32.Ddeml.HCONV, com.sun.jna.platform.win32.Ddeml.HSZ, int, int, int, com.sun.jna.platform.win32.WinDef.DWORDByReference) function.The DdeGetLastError(int) function can be used to get the error code,
which can be one of the following values:
int DdeGetLastError(int idInst)
idInst - The application instance identifier obtained by a previous
call to the DdeInitialize(com.sun.jna.platform.win32.WinDef.DWORDByReference, com.sun.jna.platform.win32.Ddeml.DdeCallback, int, int) function.Ddeml.DMLERR_*Ddeml.HSZ DdeCreateStringHandle(int idInst, java.lang.String psz, int iCodePage)
idInst - The application instance identifier obtained by a previous
call to the DdeInitialize(com.sun.jna.platform.win32.WinDef.DWORDByReference, com.sun.jna.platform.win32.Ddeml.DdeCallback, int, int) function.psz - The null-terminated string for which a handle is to be created.
This string can be up to 255 characters. The reason for this limit is that
DDEML string management functions are implemented using atoms.iCodePage - The code page to be used to render the string. This
value should be either CP_WINANSI (the default code page) or
CP_WINUNICODE, depending on whether the ANSI or Unicode version of
DdeInitialize(com.sun.jna.platform.win32.WinDef.DWORDByReference, com.sun.jna.platform.win32.Ddeml.DdeCallback, int, int) was called by the client application.If the function fails, the return value is 0L.
The DdeGetLastError(int) function can be used to get the error code, which
can be one of the following values:
int DdeQueryString(int idInst,
Ddeml.HSZ hsz,
Pointer psz,
int cchMax,
int iCodePage)
idInst - The application instance identifier obtained by a previous
call to the DdeInitialize(com.sun.jna.platform.win32.WinDef.DWORDByReference, com.sun.jna.platform.win32.Ddeml.DdeCallback, int, int) function.hsz - A handle to the string to copy. This handle must have been
created by a previous call to the DdeCreateStringHandle(int, java.lang.String, int) function.psz - A pointer to a buffer that receives the string. To obtain the
length of the string, this parameter should be set to NULL.cchMax - The length, in characters, of the buffer pointed to by the
psz parameter. For the ANSI version of the function, this is the number
of bytes; for the Unicode version, this is the number of characters.
If the string is longer than ( cchMax� 1), it will be truncated. If the
psz parameter is set to NULL, this parameter is ignored.iCodePage - The code page used to render the string. This value
should be either CP_WINANSI or CP_WINUNICODE.If an error occurs, the return value is 0L
boolean DdeFreeStringHandle(int idInst,
Ddeml.HSZ hsz)
idInst - The application instance identifier obtained by a previous
call to the DdeInitialize(com.sun.jna.platform.win32.WinDef.DWORDByReference, com.sun.jna.platform.win32.Ddeml.DdeCallback, int, int) function.hsz - A handle to the string handle to be freed. This handle must
have been created by a previous call to the DdeCreateStringHandle(int, java.lang.String, int)
function.boolean DdeKeepStringHandle(int idInst,
Ddeml.HSZ hsz)
DdeQueryConvInfo(com.sun.jna.platform.win32.Ddeml.HCONV, int, com.sun.jna.platform.win32.Ddeml.CONVINFO) function.idInst - The application instance identifier obtained by a previous
call to the DdeInitialize(com.sun.jna.platform.win32.WinDef.DWORDByReference, com.sun.jna.platform.win32.Ddeml.DdeCallback, int, int) function.hsz - A handle to the string handle to be saved.