IExpressionStore::GetExprID Method
Use this method to translate the name of an expression into its corresponding expression ID.
HRESULT IExpressionStore::GetExprID(
BSTR strExprName,
long* pnExprID
);
Function GetExprID(
strExprName As String
) As Long
Parameters
strExprName
[C++][in] A BSTR that contains the expression name.
[Visual Basic]
A String that contains the expression name.
pnExprID
[C++][out, retval] A pointer to a long that contains the expression ID. On failure, the expression ID is set to EXPRID_INVALID (defined as -1).
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 Long that contains the expression ID. On failure, the expression ID is set to EXPRID_INVALID (defined as -1).
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.
Constant |
Value |
Description |
|---|---|---|
E_EXPR_BADCONNECTION |
0x8110001F &H8110001F |
Invalid connection |
E_EXPR_BADEXPRNAME |
0x81100003 &H81100003 |
Invalid expression name, or expression name not found in store |
E_EXPR_NOCONNECTIONSTRING |
0x8110000D &H8110000D |
No connection string specified |
[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 GetExprName method to translate the ID of an expression into its corresponding expression name.
Call the Connect method before calling the GetExprID method.
The ppExprID parameter contains valid data only if the method completes successfully.
Example
' lExpressionID is a long.
' oExpressionStore is an ExpressionStore object connected to
' a valid expression store.
lExpressionID = oExpressionStore.GetExprID("MyExpression")
See Also
Other Resources
IExpressionStore::Connect Method
IExpressionStore::GetExpression Method