Open Core Interface - MLPI
MLPI-MotionLogicProgrammingInterface(mlpi4COM)  1.26.2
IBuffers Interface Reference

Inherits IDispatch.

Collaboration diagram for IBuffers:
Collaboration graph

Properties

IBuffer Item ([in] VARIANT bufferName) [get]
 

Detailed Description

Definition of the IBuffers interface which is a collection of IBuffer objects.

Use the IBuffers interface to get the references of an IBuffer object. IBuffer objects are referenced by their name. To get a list of all available modules you can use the method ITrace::GetBufferList in the class ITrace.

Definition at line 74 of file IBuffers.idl.

Property Documentation

IBuffer IBuffers::Item([in] VARIANT bufferName)
get

This property returns an IBuffer object given by name of the buffer.

Parameters
[in]bufferNameThe name (e.g. "MAIN") of the buffer to get the interface for.
[out]ppBufferReturns the IBuffer interface of the given trace buffer.
Returns
Return value indicating success (>=0) or error (<0).
Example C#:
...
try
{
// let's get the buffer object to the buffer which is called "MAIN"
IBuffer bufferMain = connection.Trace.Buffers["MAIN"];
// use buffer object to print name of the buffer
Console.WriteLine("BufferName: " + bufferMain.NameOfBuffer);
}
catch (System.Exception ex)
{
Console.WriteLine("Error: " + ex.Message);
}

The documentation for this interface was generated from the following file: