ExpressionStore.GetExprID

Ee825761.c++_on(en-US,CS.10).gifEe825761.vb_off(en-US,CS.10).gif

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

Definition

Function GetExprID(strExprName As String) As Long

Parameters

strExprName

[in] A String that contains the expression name.

Return Values

If this method completes successfully, it returns a Long that contains the expression ID. On failure, the expression ID is set to EXPRID_INVALID (defined as -1).

Error Values

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.

Constant Value Description
E_EXPR_BADCONNECTION &H8110001F Invalid connection
E_EXPR_BADEXPRNAME &H81100003 Invalid expression name, or expression name not found in store
E_EXPR_NOCONNECTIONSTRING &H8110000D No connection string specified

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 GetExprName method to translate the ID of an expression into its corresponding expression name.

Call the Connect method before calling the GetExprID method.

For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.

Example

' lExpressionID is a long
' oExpressionStore is an ExpressionStore object connected to
' a valid expression store.

lExpressionID = oExpressionStore.GetExprID("MyExpression")

See Also

ExpressionStore Object

ExpressionStore.Connect

ExpressionStore.GetExpression

ExpressionStore.GetExprName

ExpressionStore.RenameExpression


All rights reserved.