Rate This Document
Findability
Accuracy
Completeness
Readability

Information Setting

Function Syntax

  • Define a dimension.

    int ncmpi_def_dim(int fileId, const char* name, MPI_Offset length, int* idPoint);

  • Define a variable.

    int ncmpi_def_var(int fileId, const char* name, int dataType, int dimNumber, const int* dimsArray, int* idPoint);

Parameters

Parameter

Description

Value Range

Input/Output

fileId

File ID

Non-negative integer

Input

*name

Dimension or variable name

Non-empty string of less than 256 bytes

Input

length

Dimension length

Non-negative integer

Input

*idPoint

Destination address for storing the dimension ID handle

Non-empty

Input

dataType

Variable data type

Non-empty

Input

*dimsArray

Dimension ID array

Non-empty

Input

dimNumber

Number of dimensions

Non-negative integer

Input

*idPoint

Pointer to the variable ID

Non-empty

Output

Return Value

  • Success: NC_NOERR
  • Failure: An error code is returned.

Error Code

Error Code

Description

NC_EBADID

Invalid ncid

NC_EBAD_FILE

Invalid file name

NC_ENOMEM

Null pointer or invalid memory