Admin Production ni-theme
Current Publication

ClientDDEExecute

LabWindows/CVI

ClientDDEExecute

int ClientDDEExecute (unsigned int conversationHandle, char commandString[], unsigned int timeOut);

Purpose

Allows your program, acting as a DDE client, to send a command string to the server. Each server defines its own set of valid command strings.

ClientDDEExecute returns zero for success or a negative error code for failure.

Parameters

Input
Name Type Description
conversationHandle unsigned int The conversation handle that uniquely represents the connection between the server and the client.
commandString char [] The command string for the DDE server to execute. Each server defines its own set of valid command strings.

Neither NULL nor an empty string are allowed.

Refer to the server application documentation for more information about the commands supported.
timeOut unsigned int The number of milliseconds to wait for a DDE read or write operation to complete.

If a value of zero is passed, then a default timeout of 5000 milliseconds is used.

Return Value

Name Type Description
status int Return value indicating whether the function was successful.

A negative number represents the error code. For functions that read or write data (ClientDDERead, ClientDDEWrite, ServerDDEWrite, AdviseDDEDataReady, BroadcastDDEDataReady), if the function was successful, the return value is the number of bytes transferred. For other DDE Support Library functions, zero represents successful execution.

The enumerated type that specifies the absolute values of the error codes is declared in ddesupp.h. For instance, if an invalid parameter is passed, kDDE_InvalidParameter is returned.

Currently, a maximum of 255 concurrent conversations are allowed at any one time. If you exceed this limit, –kDDE_TooManyConversations will be returned.

Error codes from –16 to –33 are native DDEML errors, which correspond to Windows DDE error codes starting from 0x4000.

Additional Information

Library: DDE Support Library

Include file: ddesupp.h

LabWindows/CVI compatibility: LabWindows/CVI 3.0 and later