1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
|
<?xml version="1.0" encoding="UTF-8"?>
<!--
* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
* Copyright (C) 2009 - DIGITEO - Sylvestre LEDRU
*
* This file must be used under the terms of the CeCILL.
* This source file is licensed as described in the file COPYING, which
* you should have received as part of this distribution. The terms
* are also available at
* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
*
-->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="StringManagement_callscilab" xml:lang="en">
<refnamediv>
<refname>String management</refname>
<refpurpose>How to manage Scilab's String read and write process using
call_scilab and api_scilab
</refpurpose>
</refnamediv>
<refsection>
<title>Description</title>
<para>This help describes how strings and matrix of strings can be handle
through the <link linkend="call_scilab">Call Scilab API</link> and <link linkend="api_scilab">api Scilab</link>.
</para>
<para>There are several functions which can be used to read / write from
the memory of Scilab. These functions are described in dedicated
pages.
</para>
<para>
<note>
Note: Access to variables is done through <link linkend="api_scilab">api Scilab</link> (named variable).
</note>
</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting role="example"><![CDATA[
// This example shows how to write a Scilab string in Scilab engine
// It is the equivalent to A="my Message"; in Scilab interpretor
// See: modules/call_scilab/examples/basicExamples/readwritestring.c
// StartScilab
int row = 1, col = 1; /* Size of the matrix */
/* Declare the string */
char **myMatrixOfString = (char**)malloc(sizeof(char*) * row * col);
myMatrixOfString[0]="my Message";
char variableName[] = "A";
SciErr sciErr;
/* Write it into Scilab's memory */
sciErr = createNamedMatrixOfString(pvApiCtx, variableName, row, col, myMatrixOfString);
if(sciErr.iErr)
{
printError(&sciErr, 0);
}
/*
* Prior to Scilab 5.2
* C2F(cwritechain)(variableName, &sizeOfMyString , myString, strlen(variableName), sizeOfMyString);
*/
printf("Display from Scilab of A:\n");
SendScilabJob("disp(A);"); /* Display A */
]]></programlisting>
<programlisting role="example"><![CDATA[
/* Load the previously set variable A */
// See: modules/call_scilab/examples/basicExamples/readwritestring.c
char variableToBeRetrieved[]="A";
int iRows = 0;
int iCols = 0;
int i,j;
int* piAddr = NULL;
int* piLen = NULL;
char** pstData = NULL;
SciErr sciErr;
//first call to retrieve dimensions
sciErr = readNamedMatrixOfString(pvApiCtx,variableToBeRetrieved,&iRows, &iCols, NULL, NULL);
if(sciErr.iErr)
{
printError(&sciErr, 0);
}
piLen = (int*)malloc(sizeof(int) * iRows * iCols);
//second call to retrieve length of each string
sciErr = readNamedMatrixOfString(pvApiCtx,variableToBeRetrieved, &iRows, &iCols, piLen, NULL);
if(sciErr.iErr)
{
printError(&sciErr, 0);
}
pstData = (char**)malloc(sizeof(char*) * iRows * iCols);
for(i = 0 ; i < iRows * iCols ; i++)
{
pstData[i] = (char*)malloc(sizeof(char) * (piLen[i] + 1));//+ 1 for null termination
}
//third call to retrieve data
sciErr = readNamedMatrixOfString(pvApiCtx, variableToBeRetrieved, &iRows, &iCols, piLen, pstData);
if(sciErr.iErr)
{
printError(&sciErr, 0);
}
printf("\n");
printf("Load and display of A:\n");
for(j = 0 ; j < iCols ; j++)
{
for(i = 0 ; i < iRows ; i++)
{
/* Display the formated matrix with same scilab indice */
printf("[%d,%d] = %s\n",j+1,i+1,pstData[j* iRows + i]);
}
}
printf("\n");
free(piLen);
for(i = 0 ; i < iRows * iCols ; i++)
{
free(pstData[i]);
}
free(pstData);
]]></programlisting>
</refsection>
<refsection role="see also">
<title>See Also</title>
<simplelist type="inline">
<member>
<link linkend="call_scilab">Call_Scilab</link>
</member>
<member>
<link linkend="api_scilab">api Scilab</link>
</member>
<member>
<link linkend="SendScilabJob">SendScilabJob</link>
</member>
<member>
<link linkend="StartScilab">StartScilab</link>
</member>
<member>
<link linkend="BooleanManagement_callscilab">Call_Scilab: Boolean Management</link>
</member>
<member>
<link linkend="DoubleManagement_callscilab">Call_Scilab: Double Management</link>
</member>
<member>
<link linkend="boolean_reading_API">API_Scilab: Boolean Reading</link>
</member>
<member>
<link linkend="boolean_writing_API">API_Scilab: Boolean Writing</link>
</member>
<member>
<link linkend="Double_management_reading_API">API_Scilab: Double Reading</link>
</member>
<member>
<link linkend="Double_management_writing_API">API_Scilab: Double Writing</link>
</member>
<member>
<link linkend="ComplexManagement_callscilab">Complex Management</link>
</member>
</simplelist>
</refsection>
</refentry>
|