NCM_GetVariableAttributes( )

---

Description | Cautions | Example | Error Codes

Name:	NCMRetCode NCM_GetVariableAttributes ( pncmFamily, pncmDevice, pncmVariable, pncm VariableAttribs )
Inputs:	NCMFamily *pncmFamily	pointer to a structure containing a family of boards
	NCMDevice *pncmDevice	pointer to a structure containing a device name
	NCMVariable *pncmVariable	pointer to a structure containing a property section
	NCMVariableAttributes *pncmVariableAttribs	pointer to a structure containing the variable's attributes
Returns:	NCM_SUCCESS if success NCM error code if failure
Includes:	NCMApi.h
Mode:	synchronous

Description

The NCM_GetVariableAttributes( ) function returns the parameter's attributes.

This function fills a pointer to a pointer with the beginning address of a list of variables for a particular property section.

The function parameters are defined as follows:

Parameter	Description
pncmFamily	points to the family of boards to which the device belongs
pncmDevice	pointer to the device for which the variables should be returned
pncmVariable	pointer to a variable
pncmVariableAttribs	pointer to the where the variable's attributes are returned

Cautions

The global or family-level calls are not fully supported. Default values are returned with return code of NCM_SUCCESS.

Example

#include "NCMApi.h" 
...
//
// Prepare inputs
// 
NCMFamily family;
family.name = "D/x1E";
family.next = NULL; 
NCMDevice device;
device.name = "D/41E-1";
device.next = NULL; 
NCMVariable variable;
variable.name = "BLTAddrerss";
variable.next = NULL; 
NCMVariableAttribute pVariableAttribs; 
//
// Execute
// 
NCMRetCode     ncmRc = NCM_GetVariableAttributes( &family, &device,
                                                  &variable, &pVariableAttribs );
if ( ncmRc == NCM_SUCCESS )
{
// Process Attributes
   ...
}
else
{     // Process error
     ...
} 
... 

Error Codes

Equate	Returned When
NCME_DATA_NOT_FOUND	Requested data not found in NCM data storage
NCME_INVALID_INPUTS	Invalid inputs

Click here to contact Telecom Support Resources