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.
Replacement in Object TOOLKIT: |
Synopsis
#include <ProUtil.h>
ProConfigoptionGet | |
( 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
The function successfully retrieved the information. | |
Either the specified option or the option value is NULL. | |
The specified option was not found. | |
The function returned the option value, but the option is longer than the maximum ProPath. |
Sample Code References
User Guide References