SalDDE

PPJ.Runtime.DDE.SalDDE

Namespace: PPJ.Runtime.DDE

Assembly: PPJ.Runtime.DDE.49 (4.9.0.0)

Summary description for SalDDE.

C#

public class SalDDE

VB.NET

Public Class SalDDE

Methods

AddAtom(stringToAdd)

Adds a string to the global atom table and creates a new atom to identify the string.

Parameter	Type	Description
stringToAdd	SalString

Returns: SalNumber.

Alloc()

Allocates a memory handle for WM_DDE_Data or WM_DDE_Poke message.

Returns: SalNumber.

DeleteAtom(atomToDelete)

Decrements an atom's reference count.

Parameter	Type	Description
atomToDelete	SalNumber	The atom to delete.

Returns: SalNumber.

Extract(msg, wParam, lParam, sender, lowlParam, highlParam)

Parameter	Type	Description
msg	SalNumber
wParam	SalNumber
lParam	SalNumber
sender	SalWindowHandle&
lowlParam	SalNumber&
highlParam	SalNumber&

Returns: SalBoolean.

ExtractCmd(handle, command, commandSize)

Parameter	Type	Description
handle	SalNumber
command	SalString&
commandSize	SalNumber

Returns: SalBoolean.

ExtractDataText(handle, status, data, dataSize)

Parameter	Type	Description
handle	SalNumber
status	SalNumber&
data	SalString&
dataSize	SalNumber

Returns: SalBoolean.

ExtractOptions(options, flags, format)

Parameter	Type	Description
options	SalNumber
flags	SalNumber&
format	SalNumber&

Returns: SalBoolean.

FindAtom(topicString)

Searches the global atom table and returns the atom associated with the given string.

Parameter	Type	Description
topicString	SalString	The string to search for.

Returns: SalNumber. nAtom

Free(memory)

Frees a memory handle allocated by SalDDEAlloc for WM_DDE_Data or WM_DDE_Poke messages.

Parameter	Type	Description
memory	SalNumber	The memory handle to free.

Returns: SalNumber. nHandle

GetAtomName(atom, atomName, stringLength)

Parameter	Type	Description
atom	SalNumber
atomName	SalString&
stringLength	SalNumber

Returns: SalNumber.

GetExecuteString(msglParam)

Converts the lParam of the SAM_DDE_ClientExecute message to a command string.

Parameter	Type	Description
msglParam	SalNumber

Returns: SalString. sCommand

Post(wndReceiver, message, wndSender, lowlParam, hnighlParam)

Posts a WM_DDE_* messages except: WM_DDE_Initiate and WM_DDE_Ack.

Parameter	Type	Description
wndReceiver	SalWindowHandle
message	SalNumber
wndSender	SalWindowHandle
lowlParam	SalNumber
hnighlParam	SalNumber

Returns: SalNumber.

Request(ctrl, service, serverTopic, serverItem, timeout, data)

Parameter	Type	Description
ctrl	Control
service	SalString
serverTopic	SalString
serverItem	SalString
timeout	SalNumber
data	SalString&

Returns: SalBoolean.

Send(receiver, message, sender, lowlParam, highlParam)

Sends a WM_DDE_* message.

Parameter	Type	Description
receiver	SalWindowHandle
message	SalNumber
sender	SalWindowHandle
lowlParam	SalNumber
highlParam	SalNumber

Returns: SalNumber.

SendAll(message, sender, lowlParam, highlParam)

Broadcasts a WM_DDE_* message.

Parameter	Type	Description
message	SalNumber
sender	SalWindowHandle
lowlParam	SalNumber
highlParam	SalNumber

Returns: SalNumber.

SendAll(message, sender, lowlParam, highlParam, timeout)

Broadcasts a WM_DDE_* message with a given Timeout

Parameter	Type	Description
message	SalNumber
sender	SalWindowHandle
lowlParam	SalNumber
highlParam	SalNumber
timeout	SalNumber

Returns: SalNumber.

SendExecute(ctrl, service, topic, item, timeout, command)

Executes a DDE command on the server.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
service	SalString
topic	SalString
item	SalString
timeout	SalNumber
command	SalString

Returns: SalBoolean.

SendToClient(ctrl, data, clientID, timeout)

Sends data to the client.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
data	SalString
clientID	SalNumber
timeout	SalNumber

Returns: SalBoolean.

SetCmd(highlParam, command)

Assigns a command string to the data referenced by the high-order word of the lParam in a WM_DDE_Execute message.

Parameter	Type	Description
highlParam	SalNumber	The handle to the command block that contains the command string.
command	SalString	The command to execute.

Returns: SalBoolean. bOk

SetData(handle, status, data, format)

Sets DDEdata from a byte array with given format

Parameter	Type	Description
handle	SalNumber	The handle to the memory object that contains the data and other information.
status	SalNumber	The status word.
data	Byte[]	The data to assign.
format	Int32	The format

Returns: SalBoolean. bOk

SetDataText(numData, status, strData)

Assigns a value to the data referenced by the low-order word of the lParam in a WM_DDE_Data or WM_DDE_Poke message.

Parameter	Type	Description
numData	SalNumber	The handle to the memory object that contains the data and other information.
status	SalNumber	The status word.
strData	SalString	The value to assign.

Returns: SalBoolean. bOk

SetOptions(options, flags, format)

Assigns a value to the data referenced by the low-order word of the lParam in a WM_DDE_Advise message.

Parameter	Type	Description
options	SalNumber	The handle to the memory object that specifies how the data is to be sent.
flags	SalNumber	The status word.
format	SalNumber	The CF_* data format.

Returns: SalBoolean. bOk

StartServer(ctrl, service, topic, item)

Creates a DDE server for the specified service, topic and item.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
service	SalString
topic	SalString
item	SalString

Returns: SalBoolean.

StartSession(ctrl, service, topic, item, timeout)

Starts a hot link conversation with a server application.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.
service	SalString
topic	SalString
item	SalString
timeout	SalNumber

Returns: SalBoolean.

StopServer(ctrl)

Stops the DDE server associated with the specified control.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

Returns: SalBoolean.

StopSession(ctrl)

Ends a hot link conversation with a server application.

Parameter	Type	Description
ctrl	Control	Target control on which to execute the call.

Returns: SalBoolean. bOk