IExpressionStore::RenameExpression
Use this method to rename an existing expression in the expression store. The new expression name must be unique or the operation will fail.
Definition
HRESULT IExpressionStore::RenameExpression(longnExprID,BSTRstrNewName);
Parameters
nExprID
[in] A long that contains the expression ID.
strNewName
[in] A BSTR that contains the new name.
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_BADEXPRID | 0x8110000A | Invalid expression ID specified, or expression ID not found in store |
E_EXPR_BADEXPRNAME | 0x81100003 | Invalid expression name |
E_EXPR_DUPEXPRNAME | 0x81100007 | Duplicate expression name |
E_EXPR_INVALIDFIELDSIZE | 0x81100005 | The new name exceeds the maximum size of 30 characters |
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 GetExprID method to translate an expression name to its corresponding expression ID.
Call the Connect method before calling the RenameExpression method.
For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.