IExpressionStore::GetExprID

Ee796740.c++_off(en-US,CS.10).gifEe796740.vb_on(en-US,CS.10).gif

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

Definition

HRESULT IExpressionStore::GetExprID(BSTRstrExprName,long*pnExprID);

Parameters

strExprName

[in] A BSTR that contains the expression name.

pnExprID

[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 Values

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

Error Values

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.

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

Constant Value Description
E_EXPR_BADCONNECTION 0x8110001F Invalid connection
E_EXPR_BADEXPRNAME 0x81100003 Invalid expression name, or expression name not found in store
E_EXPR_NOCONNECTIONSTRING 0x8110000D No connection string specified

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.

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.

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

See Also

ExpressionStore Object

IExpressionStore::Connect

IExpressionStore::GetExpression

IExpressionStore::GetExprName

IExpressionStore::RenameExpression


All rights reserved.