Category Creo Parametric fundamentals, Object ProConfigopt

Function ProConfigoptArrayGet


Description
Retrieves the current value for the specified configuration file option. This function supports multi-string options (e.g. search_path).

Note: Use this function instead of ProConfigoptGet() while retrieving the value of an option that may have multiple values or a path-length string.

Replacement in Object TOOLKIT: pfcBaseSession::GetConfigOptionValues
Synopsis
#include <ProUtil.h>
ProErrorProConfigoptArrayGet(
ProName option
/* (In)
The keyword string. This can include uppercase and lowercase letters.
*/
ProPath** value_array
/* (Out)
The option value(s), in a ProArray. The function allocates this array, free it with ProArrayFree().
*/
)
Returns
PRO_TK_NO_ERRORThe function successfully retrieved the information.
PRO_TK_BAD_INPUTSThe arguments provided are invalid.
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. Core: Utilities: Configuration Options
  2. Core: Utilities: Configuration Options

Sample Code References:

  1. pt_examples ( TestConfig.c )