[This is preliminary documentation and is subject to change.]
Retrieves an error string corresponding to the given MPI error code.
Namespace:
MPIAssembly: MPI (in MPI.dll)
Version: 0.8.0.0 (0.8.0.0)
Syntax
| C# |
|---|
public static int MPI_Error_string( int errorcode, byte[] text, ref int resultlen ) |
| Visual Basic (Declaration) |
|---|
Public Shared Function MPI_Error_string ( _ errorcode As Integer, _ text As Byte(), _ ByRef resultlen As Integer _ ) As Integer |
| Visual C++ |
|---|
public: static int MPI_Error_string( int errorcode, array<unsigned char>^ text, int% resultlen ) |
Parameters
- errorcode
- Type: System..::.Int32
The error code.
- text
- Type: array<
System..::.Byte
>[]()[]
Byte array that will be filled with a string describing the error.
- resultlen
- Type:
System..::.Int32
%
Returns the number of elements placed into the buffer text.