_OrderGroup::get_SavePrefix, put_SavePrefix
.gif "Ee825436.c++_off(en-US,CS.10).gif")
.gif "Ee825436.vb_on(en-US,CS.10).gif")
Specifies a key prefix that will prevent a dictionary entry from being saved to the database.
Definition
Get method:
HRESULT _OrderGroup::get_SavePrefix(BSTR*SavePrefix);
Put method:
HRESULT _OrderGroup::put_SavePrefix(BSTRSavePrefix);
Parameters
SavePrefix
[in] When putting the property, a BSTR that contains the save prefix.
[out, retval] When getting the property, a pointer to a BSTR used to return the save prefix.
Return Values
These methods return an HRESULT indicating whether they completed successfully. See the Error Values section for more details.
Error Values
These properties return S_OK (0x00000000) to indicate success and standard COM HRESULT error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. 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
The Value parameter contains valid data only if the property is accessed successfully.
No dictionary entry that has a key name that begins with the value of the SavePrefix property will be saved to the database. Assuming that the SavePrefix property is set to the underscore character ("_"), if the value of _adjusted_price is $ 200 and the value of total_price is $ 400, then $ 200 will not be persisted, but $ 400 will be persisted.
For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.