Category Parameters and relations, Object ProParameter

Function ProParameterIsInactive


Description
Determines whether the parameter is inactive.

NOTE:

Currently supports only symbol instance annotation element parameters. returns PRO_B_TRUE if parameter is inactive due to current customization of symbol.
Synopsis
#include <ProParameter.h>
ProErrorProParameterIsInactive(
ProParameter* param
/* (In)
The handle to the parameter to query.
*/
ProBoolean* is_inactive
/* (Out)
This is PRO_B_TRUE if the specified parameter is inactive.
*/
)
Returns
PRO_TK_NO_ERRORThe function successfully retrieved the information.
PRO_TK_E_NOT_FOUNDThe owner was not found.
PRO_TK_INVALID_TYPEowner of parameter do not support inactive parameters.
PRO_TK_GENERAL_ERRORThe parameter was not found, or the function could not perform the action.

Manual References:

  1. Core: Parameters: Accessing Parameters