Share via


IDiaSymbol::get_rank

Applies to: yesVisual Studio noVisual Studio for Mac

Note

This article applies to Visual Studio 2017. If you're looking for the latest Visual Studio documentation, see Visual Studio documentation. We recommend upgrading to the latest version of Visual Studio. Download it here

Retrieves the rank (number of dimensions) of a FORTRAN multi-dimensional array.

Syntax

HRESULT get_rank ( 
   DWORD* pRetVal
);

Parameters

pRetVal

[out] Returns the number of dimensions in a FORTRAN multi-dimensional array.

Return Value

If successful, returns S_OK; otherwise, returns S_FALSE or an error code.

Note

A return value of S_FALSE means the property is not available for the symbol.

Remarks

Rank refers to the number of dimensions in an array where the array is declared as myarray[1,2,3]. This example has a rank of 3 and 3 dimensions. Rank does not apply to C++ which uses the concept of an array of arrays for each dimension (that is, myarray[1][2][3]).

See also