OpenersNotesSection(Spacer1)Details

The array a is laid out in memory like a C array declared as double a[m][n]….

heads gives a list of character strings corresponding to the names of symbols that appear as heads at each level in the array.

WSGetReal64Array() allocates memory which must be released by calling (NonWLLink[WSReleaseReal64Array(), paclet:ref/c/WSReleaseReal64Array]). If WSGetReal64Array() fails and the function's return value indicates an error, do not call (NonWLLink[WSReleaseReal64Array(), paclet:ref/c/WSReleaseReal64Array])on the contents of a.

WSGetReal64Array() returns immutable data.

WSGetReal64Array() returns 0 in the event of an error, and a nonzero value if the function succeeds.

Use (NonWLLink[WSError(), paclet:ref/c/WSError]) to retrieve the error code if WSGetReal64Array() fails.

WSGetReal64Array() is declared in the WSTP header file (RefLink[wstp.h, paclet:ref/file/wstp.h]).

OpenersPrimaryExamplesSection(Spacer1)Examples  (1)

OpenersExampleSection0(Spacer1)Basic Examples  (1)

#include "wstp.h"

/* read an array of double-precision floating-point numbers from a link */

void f(WSLINK lp)
{
	double *data;
	int *dims;
	char **heads;
	int d; /* stores the rank of the array */

	if(! WSGetReal64Array(lp, &data, &dims, &heads, &d))
		{
			/* unable to read the array from lp */
			return;
		}

	/* ... */

	WSReleaseReal64Array(lp, data, dims, heads, d);	
}

({{DocumentationFooterIconsRelatedFunction.png, ({{See Also}, {(NonWLLink[WSGetReal32Array(), paclet:ref/c/WSGetReal32Array])  ▪  (NonWLLink[WSGetReal128Array(), paclet:ref/c/WSGetReal128Array])}})}})

({{DocumentationFooterIconsRelatedTutorial.png, ({{Tutorials}, {▪(RefLinkPlain[Manipulating Expressions in External Programs, paclet:tutorial/ManipulatingExpressionsInExternalPrograms])}, {▪(RefLinkPlain[Handling Lists, Arrays and Other Expressions, paclet:tutorial/HandlingListsArraysAndOtherExpressions])}, {▪(RefLinkPlain[Portability of WSTP Programs, paclet:tutorial/PortabilityOfWSTPPrograms])}, {▪(RefLinkPlain[WSTP C API Developer Guide (Mac OS X), paclet:tutorial/WSTPDeveloperGuide-MacintoshOverview])}, {▪(RefLinkPlain[WSTP C API Developer Guide (Unix and Linux), paclet:tutorial/WSTPDeveloperGuide-UnixOverview])}, {▪(RefLinkPlain[WSTP C API Developer Guide (Windows), paclet:tutorial/WSTPDeveloperGuide-WindowsOverview])}})}})

({{DocumentationFooterIconsRelatedGuide.png, ({{Related Guides}, {▪(RefLinkPlain[Alphabetical Listing of WSTP C Functions, paclet:guide/AlphabeticalListingOfWSTPCFunctions])}, {▪(RefLinkPlain[WSTP C Functions for Exchanging Multidimensional Arrays, paclet:guide/WSTPCFunctionsForExchangingMultidimensionalArrays])}, {▪(RefLinkPlain[WSTP C Functions for Exchanging Reals, paclet:guide/WSTPCFunctionsForExchangingReals])}})}})