IGPUtilities.GenerateDefaultOutputValue Method

Generates the default output value and sets its path to an unique name.

[Visual Basic .NET]
Public Function GenerateDefaultOutputValue ( _
    ByVal pEnvMgr As IGPEnvironmentManager, _
    ByVal functionname As String, _
    ByVal pOutputParam As IGPParameter, _
    ByVal pInputValue As IGPValue, _
    ByVal extension As String, _
    ByVal outputFileBaseLimit As Integer _
) As IGPValue

[C#]
public IGPValue GenerateDefaultOutputValue (
    IGPEnvironmentManager pEnvMgr,
    string functionname,
    IGPParameter pOutputParam,
    IGPValue pInputValue,
    string extension,
    int outputFileBaseLimit
);

[C++]
HRESULT GenerateDefaultOutputValue(
  IGPEnvironmentManager* pEnvMgr,
  BSTR functionname,
  IGPParameter* pOutputParam,
  IGPValue* pInputValue,
  BSTR extension,
  long outputFileBaseLimit,
  IGPValue** ppOutputValue
);

[C++]

Parameters
pEnvMgr [in]

  pEnvMgr is a parameter of type IGPEnvironmentManager
functionname [in]
  functionname is a parameter of type BSTR
pOutputParam [in]

  pOutputParam is a parameter of type IGPParameter
pInputValue [in]

  pInputValue is a parameter of type IGPValue
extension [in]
  extension is a parameter of type BSTR
outputFileBaseLimit [in]
  outputFileBaseLimit is a parameter of type long
ppOutputValue [out, retval]

  ppOutputValue is a parameter of type IGPValue

Product Availability

Remarks

The GenerateDefaultOutputValue method is called during validation inside IGPFunction_Validate to return an output path as a value object [IGPValue].

See Also