NCM_GetPropertyAttributes( )

---

Description | Cautions | Example | Error Codes

Name:	NCMRetCode NCM_GetPropertyAttributes ( pncmFamily, pncmDevice, pncmProperty, pncmPropAttribs )
Inputs:	NCMFamily *pncmFamily	pointer to a structure containing a device family name
	NCMDevice *pncmDevice	pointer to a structure containing a device name
	NCMProperty *pncmProperty	pointer to structure containing a property section
	NCMPropertyAttribute *pncmPropAttribs	pointer to a structure containing the property's attributes
Returns:	NCM_SUCCESS if success NCM error code if failure
Includes:	NCMApi.h
Mode:	synchronous

Description

The NCM_GetPropertyAttributes( ) function gets a properties attributes.

This function queries the system configuration to return a property's attributes- (VISIBLE/HIDDEN).

The function parameters are defined as follows:

Parameter	Description
pncmFamily	pointer to the structure containing the family name
pncmDevice	pointer to the structure containing a device name; the device name can be either a device model name or a unique device name (the unique device name must be the same name you used to add the device to the system configuration with the NCM_AddDevice( ) function)
pncmProperties	pointer to the structure containing the property name
pncmPropAttribs	pointer to the property's attributes to be returned

Cautions

None

Example

#include "NCMApi.h" 
...
//
// Prepare inputs
// 
NCMFamily family;
family.name = "D/x1D";
family.next = NULL; 
NCMDevice device;
device.name = "D/41D-1";
device.next = NULL; 
NCMProperty propert;
property.name = "Misc";
property.next = NULL; 
NCMPropertyAttributes pPropAttribs; 
//
// Execute
// 
NCMRetCode     ncmRc = NCM_GetPropertyAttributes( &family, &device, &property,
                                                           &pPropAttribs ); 
if ( ncmRc == NCM_SUCCESS )
{
     //Process attributes
       ...
}
else
{     //Process error
    ...
}
... 

Error Codes

Equate	Returned When
NCME_INVALID_INPUTS	invalid inputs
NCME_DATA_NOT_FOUND	requested data not found in NCM data storage

Click here to contact Telecom Support Resources