IsValidOptProbInst function

Syntax

IsValidOptProbInst(probinst [, &detailedstatus])

Description

IsValidOptProbInst determines if a given analytic instance exists in the optimization metadata.

Parameters

Parameter	Description
probinst	Enter the analytic instance ID to be validated.
&detailedstatus	(Optional) This status reference parameter returns an integer value giving further information about the evaluation of this function. The value returned is one of the following: %OptEng_Success: The function completed successfully. %OptEng_Invalid_Piid: The analytic type name passed to the function is invalid.

Parameter

Description

probinst

Enter the analytic instance ID to be validated.

&detailedstatus

(Optional) This status reference parameter returns an integer value giving further information about the evaluation of this function. The value returned is one of the following:

%OptEng_Success: The function completed successfully.
%OptEng_Invalid_Piid: The analytic type name passed to the function is invalid.

Returns

This method returns a constant. Valid values are:

Value	Description
%OptEng_Success	Returned if method succeeds.
%OptEng_Fail	Returned if the method fails.

Example

Local string &probinst;
Local integer &detailedstatus;
Local integer &ret;

&probinst = "PATSMITH";
&ret = IsValidOptProbInst(&probinst, &detailedstatus);
If &ret <> %OptEng_Success and &detailedstatus=%OptEng_Invalid_Piid Then
   <perform some action>
End-if;