Object ProConfigoption

Function ProConfigoptionGet


Description
Retrieves the current value for the specified configuration file option. This function truncates the results of the query to PRO_PATH_SIZE-1 characters.

Note: While retrieving the value of an option that may have multiple values, use ProConfigoptArrayGet() instead of this function.
Synopsis
#include <ProUtil.h>
ProErrorProConfigoptionGet(
ProName option
/* (In)
The keyword string. This can include uppercase and lowercase letters.
*/
ProPath option_value
/* (Out)
The value of the keyword string, as it appears in the configuration file.
*/
)
Returns
PRO_TK_NO_ERRORThe function successfully retrieved the information.
PRO_TK_BAD_INPUTSEither the specified option or the option value is NULL.
PRO_TK_E_NOT_FOUNDThe specified option was not found.
PRO_TK_LINE_TOO_LONGThe function returned the option value, but the option is longer than the maximum ProPath.

Manual References:

  1. Pro/DEVELOP to Creo Toolkit Function Mapping: Equivalent Pro/DEVELOP Functions
  2. Core: Utilities: Configuration Options
  3. Core: Utilities: Configuration Options

Sample Code References:

  1. pt_examples ( TestConfig.c )