NetCDF 4.9.3
Loading...
Searching...
No Matches
nc4dim.c File Reference
#include "nc4internal.h"
#include "nc4dispatch.h"

Go to the source code of this file.

Functions

int NC4_inq_dimid (int ncid, const char *name, int *idp)
 
int NC4_inq_unlimdim (int ncid, int *unlimdimidp)
 
int NC4_inq_unlimdims (int ncid, int *nunlimdimsp, int *unlimdimidsp)
 

Detailed Description

This file is part of netcdf-4, a netCDF-like interface for HDF5, or a HDF5 backend for netCDF, depending on your point of view.

This file handles the nc4 dimension functions.

Author
Ed Hartnett

Definition in file nc4dim.c.

Function Documentation

◆ NC4_inq_dimid()

int NC4_inq_dimid ( int ncid,
const char * name,
int * idp )

Given dim name, find its id. Fully qualified names are legal

Parameters
ncidFile and group ID.
nameName of the dimension to find.
idpPointer that gets dimension ID.
Returns
NC_NOERR No error.
NC_EBADID Bad ncid.
NC_EBADDIM Dimension not found.
NC_EINVAL Invalid input. Name must be provided.
Author
Ed Hartnett

Definition at line 85 of file nc4dim.c.

◆ NC4_inq_unlimdim()

int NC4_inq_unlimdim ( int ncid,
int * unlimdimidp )

Netcdf-4 files might have more than one unlimited dimension, but return the first one anyway.

Note
that this code is inconsistent with nc_inq
Parameters
ncidFile and group ID.
unlimdimidpPointer that gets ID of first unlimited dimension, or -1.
Returns
NC_NOERR No error.
NC_EBADID Bad ncid.
Author
Ed Hartnett

Definition at line 33 of file nc4dim.c.

◆ NC4_inq_unlimdims()

int NC4_inq_unlimdims ( int ncid,
int * nunlimdimsp,
int * unlimdimidsp )

Returns an array of unlimited dimension ids.The user can get the number of unlimited dimensions by first calling this with NULL for the second pointer.

Parameters
ncidFile and group ID.
nunlimdimspPointer that gets the number of unlimited dimensions. Ignored if NULL.
unlimdimidspPointer that gets arrray of unlimited dimension ID. Ignored if NULL.
Returns
NC_NOERR No error.
NC_EBADID Bad ncid.
Author
Ed Hartnett, Dennis Heimbigner

Definition at line 172 of file nc4dim.c.