gsdItem

Get GSD item by number

Description:

This routine looks up the GSD item specified by its number and returns the name of the item. This routine also returns the unit string, the type specification and the array flag.

Invocation

int gsdItem( void ∗file_dsc, void ∗item_dsc, int itemno, char ∗name, char ∗unit, char ∗type, char ∗array );

Arguments

void ∗file_dsc (Given)
The GSD file descriptor related to the file opened on fptr.
void ∗item_dsc (Given)
The array of GSD item descriptors related to the file opened on fptr.
char ∗data_ptr (Given)
The buffer with all the data from the GSD file opened on fptr.
int itemno (Given)
The number of the item in the GSD file.
char ∗name (Returned)
The name of the item. This should be an array of 16 characters (char name[16]) and will be a null-terminated string.
char ∗unit (Returned)
The unit of the item. This should be an array of 11 characters (char name[11]) and will be a null-terminated string.
char ∗type (Returned)
The data type of the item. This is a single character and one of B, L, W, I, R, D, C.
char ∗array (Returned)
The array flag. This is a single character and true (false) if the item is (is not) and array.

Returned Value

int gsdFind();
Status.

  • [1:] If the named item cannot be found.

  • [0:] Otherwise.

Prototype

available via #include "gsd.h"

Copyright

Copyright (C) 1986-1999 Particle Physics and Astronomy Research Council. All Rights Reserved.