This is machine translation

Translated by Microsoft
Mouseover text to see original. Click the button below to return to the English version of the page.

Note: This page has been translated by MathWorks. Click here to see
To view all translated materials including this page, select Country from the country navigator on the bottom of this page.

GetFullMatrix

Matrix from Automation server workspace

Synopsis

IDL Method Signature

GetFullMatrix([in] BSTR varname, [in] BSTR workspace, 
[in, out] SAFEARRAY(double) *pr, [in, out] SAFEARRAY(double) *pi)

Microsoft Visual Basic Client

GetFullMatrix(varname As String, workspace As String, 
[out] XReal As Double, [out] XImag As Double

MATLAB Client

[xreal ximag] = GetFullMatrix(h,'varname','workspace',zreal,zimag)

Description

[xreal ximag] = GetFullMatrix(h,'varname','workspace',zreal,zimag) gets matrix stored in variable varname from the specified workspace of the server attached to handle h. The function returns the real part in xreal and the imaginary part in ximag. The values for workspace are base or global.

The zreal and zimag arguments are matrices of the same size as the real and imaginary matrices (xreal and ximag) returned from the server. The zreal and zimag matrices are commonly set to zero.

Use GetFullMatrix for 2-D matrices with values of type double only. Use GetVariable or GetWorkspaceData for other types. To use higher dimensional matrices, reshape the 2-D matrix after receiving it from MATLAB®.

For VBScript clients, use the GetWorkspaceData and PutWorkspaceData functions to pass numeric data to and from the MATLAB workspace. These functions use the variant data type instead of the safearray data type used by GetFullMatrix and PutFullMatrix. VBScript does not support safearray.

Visual Basic .NET Examples

This example uses a Visual Basic® .NET client to read data from a MATLAB Automation server. To run examples in products that execute VBA code, see Tips.

  1. Create the Visual Basic application. To control flow between MATLAB and the application, use the MsgBox command.

    Dim MatLab As Object
    Dim Result As String
    Dim XReal(4, 4) As Double
    Dim XImag(4, 4) As Double
    Dim i, j As Integer
    
    MatLab = CreateObject("matlab.application")
    Result = MatLab.Execute("M = rand(5);")
    MsgBox("In MATLAB, type" & vbCrLf _
        & "M(3,4)")
    
    MatLab.GetFullMatrix("M", "base", XReal, XImag)
    i = 2   %0-based array
    j = 3
    
    MsgBox("XReal(" & i + 1 & "," & j + 1 & ")" & _
        " = " & XReal(i, j))
  2. Open the MATLAB window and type:

    M(3,4)
  3. To close and terminate MATLAB, click OK.

Tips

  • To run examples in Microsoft® Office products that execute VBA code, replace the statement:

    MatLab = CreateObject("matlab.application")

    with:

    Set MatLab = CreateObject("matlab.application")
    

    If you need more information, then refer to your VBA product documentation.

Introduced before R2006a