IExpressionStore::GetExprName Method

Use this method to translate the ID of an expression into its corresponding expression name.

HRESULT IExpressionStore::GetExprName(
  long nExprID,
  BSTR*pstrExprName
);

Function GetExprName(
    nExprID As Long
) As String

Parameters

• nExprID
  [C++]

  [in] A long that contains a unique expression ID.

  [Visual Basic]

  A Long that contains a unique expression ID.

• pstrExprName
  [C++]

  [out, retval] A pointer to a BSTR that contains the name of the expression. On failure, the expression name is set to NULL.

Return Value

[C++]

This method returns an HRESULT indicating whether it completed successfully. See the Error Values section for more details.

[Visual Basic]

If this method completes successfully, it returns a String that contains the name of the expression. An empty String is returned if the expression ID is a Long but does not represent an existing expression in the expression store.

Error Values

[C++]

This method returns S_OK (0x00000000) to indicate success and either standard or custom COM HRESULT error values to indicate failure. For more information about standard COM errors, see Standard COM Errors.

[Visual Basic]

This method sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to either standard or custom COM error values to indicate failure. For more information about standard COM errors, see Standard COM Errors.

The following table shows the custom COM errors that this method can return.

[C++]

Additional information may be available using the global Err object, which can be accessed using the API function GetErrorInfo. In particular, the GetDescription method of the IErrorInfo interface may return a text description of the error.

[Visual Basic]

Additional information may be available using the global Err object. In particular, the Description property may contain a text description of the error.

Remarks

Use the GetExprID method to translate the name of an expression into its corresponding expression ID.

Call the Connect method before calling the GetExprName method.

The pstrExprName parameter contains valid data only if the method completes successfully.

See Also

Other Resources

ExpressionStore Object

IExpressionStore::Connect Method

IExpressionStore::GetExprID Method