.NET/Link API Version 1.7 USE FRAMES

IMathLink Members

IMathLink overview

Public Instance Properties

ComplexType Sets or gets the class that you want to map to Mathematica's Complex numbers.
Error Gets the current error state for the link.
ErrorMessage Gets a textual message describing the current error state for the link.
Name Gets the name of the link.
Ready Indicates whether the link has data waiting to be read.

Public Instance Methods

BytesToGet Gives the number of bytes that remain to be read in the element that is currently being read in textual form.
BytesToPut Gives the number of bytes that remain to be sent in the element that is currently being sent in textual form.
CheckFunction Reads a function name and argument count and requires that it match the specified function name.
CheckFunctionWithArgCount Reads a function name and argument count and requires that it match the specified function name and arg count.
ClearError Clears the link error condition, if possible.
Close Closes the link.
ConnectOverloaded. Connects the link, if it has not already been connected.
CreateMark Creates a mark at the current point in the incoming MathLink data stream.
DestroyMark Destroys a mark.
DeviceInformation A low-level function that retrieves special internal information from the MathLink device.
EndPacket Call when you are finished writing the contents of a single packet.
Flush Immediately transmits any data buffered for sending over the link.
GetArgCount Reads the argument count of an expression being read manually.
GetArrayOverloaded. Reads an array of the specified type and depth.
GetBoolean Reads the Mathematica symbols True or False as a bool.
GetBooleanArray Reads a list as a one-dimensional array of bools.
GetByteArray Reads a list as a one-dimensional array of bytes.
GetByteString Reads a Mathematica string as an array of bytes.
GetCharArray Reads a list as a one-dimensional array of chars.
GetComplex Reads a complex number. This can be an integer, real, or a Mathematica expression with head Complex.
GetComplexArray Reads a list as a one-dimensional array of complex numbers.
GetData Gets a specified number of bytes in the textual form of the expression currently being read.
GetDecimal Reads a Mathematica integer or real number or integer as a decimal.
GetDecimalArray Reads a list as a one-dimensional array of decimals.
GetDouble Reads a Mathematica real number or integer as a double.
GetDoubleArray Reads a list as a one-dimensional array of doubles.
GetExpr Reads an arbitrary expression from the link and creates an Expr from it.
GetExpressionType Gives the type of the current element in the expression currently being read.
GetFunction Reads a function name and argument count.
GetInt16Array Reads a list as a one-dimensional array of shorts.
GetInt32Array Reads a list as a one-dimensional array of ints.
GetInt64Array Reads a list as a one-dimensional array of longs.
GetInteger Reads a Mathematica integer as a 32-bit integer.
GetNextExpressionType Gives the type of the next element in the expression currently being read.
GetObject Reads a single expression off the link and returns an appropriate object.
GetSingleArray Reads a list as a one-dimensional array of floats.
GetString Reads a Mathematica character string.
GetStringArray Reads a list as a one-dimensional array of strings.
GetStringCRLF Reads a Mathematica character string and translates newlines into Windows format.
GetSymbol Reads a Mathematica symbol as a string.
NewPacket Discards the current packet, if it has been partially read. Has no effect if the previous packet was fully read.
NextPacket "Opens" the next packet arriving on the link.
PeekExpr Creates an Expr from the current expression, but does not drain it off the link.
PutOverloaded. Sends a .NET type as its Mathematica representation.
PutArgCount Specifies the argument count for a composite expression being sent manually.
PutData Used for sending elements in so-called "textual" form.
PutFunction Sends a function name and argument count.
PutFunctionAndArgs Sends a function name and its arguments.
PutMessage Sends a low-level MathLink message.
PutNext Identifies the type of data element that is to be sent next.
PutSize Specifies the size in bytes of an element being sent in textual form.
PutSymbol Sends a symbol.
SeekMark Resets the current position in the incoming MathLink data stream to an earlier point.
TransferExpression Reads a complete expression from the named link and writes it to this link.
TransferToEndOfLoopbackLink Reads the entire contents of a loopback link and writes it to this link.

Public Instance Events

MessageArrived Occurs when a low-level MathLink message arrives.
Yield Occurs periodically when the link is blocking in a reading call.

See Also

IMathLink Interface | Wolfram.NETLink Namespace | IKernelLink | MathLinkFactory