msiNcInqWithId ( msParam_t *  inpParam1,
msParam_t *  inpParam2,
msParam_t *  inpParam3,
msParam_t *  outParam,
ruleExecInfo_t *  rei 
)
Description:
General netcdf inquiry with id (equivalent nc_inq_dim, nc_inq_dim, nc_inq_var ....) This API is superceded by the more comprehensive rcNcInq API.
Module:
core
Since:
3.2
Author:
Mike Wan
Date:
2012
Example Usage:
See clients/icommands/test/rules3.0/netcdfTest1.r, netcdfTest2.r and netcdfTest3.r.
Parameters:
[in] inpParam1 - A STR_MS_T, INT_MS_T or NcInqIdInp_MS_T. If it is a STR_MS_T or INT_MS_T, it contains the id of the inquiry obtained from msiNcInqId.
[in] inpParam2 - If inpParam1 is a STR_MS_T or INT_MS_T, it is a INT_MS_T containing the paramType - what to inquire - valid values are defined in ncInqId.h - 0 (NC_VAR_T) or 1 (NC_DIM_T). NC_VAR_T or NC_DIM_T.
[in] inpParam3 - If inpParam1 is a STR_MS_T or INT_MS_T, it is a INT_MS_T containing ncid of the opened object for the inquiry.
[out] outParam - A NcInqWithIdOut_MS_T containing a ncInqWithIdOut_t. Elements of ncInqWithIdOut_t:

  • rodsLong_t mylong - Content depends on paramType.For NC_DIM_T, this is arrayLen. not used for NC_VAR_T.
  • int dataType - data type for NC_VAR_T.
  • int natts - number of attrs for NC_VAR_T.
  • char name[MAX_NAME_LEN] - name of the parameter.
  • int ndim - number of dimensions (rank) for NC_VAR_T.
  • int *intArray - int array of dimIds and ndim length for NC_VAR_T.
Session Variables Used:
none
Session Variables Modified:
none
iCAT Attributes Used:
none
iCAT Attributes Modified:
none
Side Effect:
none
Returns:
integer
Return values:
0 upon success
Precondition:
N/A
Postcondition:
N/A
See also:
N/A

Definition at line 387 of file reNetcdf.c.

Generated on Tue Nov 12 23:09:21 2013 for iRODS Documentation by  doxygen 1.6.3