_Auction::AuctionDeleteBid Method [C++]

Article
11/12/2009

Use this method to deletes a bid placed on an item in an auction.

Definition

[C++]

HRESULT _Auction::AuctionDeleteBid(BSTRszAuctionId,
  BSTRszShopperId,
  VARIANT_BOOLbResolve,
  VARIANT*unnamed parameter);

[Visual Basic]

Function AuctionDeleteBid(szAuctionId As String,
  szShopperId As String,
  Optional bResolve As Boolean) As Variant

Parameters

szAuctionId[C++]
[in] A BSTR that contains the unique auction ID.
szAuctionId[Visual Basic]
A String that contains the unique auction ID.
szShopperId[C++]
[in] A BSTR that contains the unique ID of the bidder.
szShopperId[Visual Basic]
A String that contains the unique ID of the bidder.
bResolve[C++]
[in, optional, defaultvalue (-1)] A VARIANT_BOOL that indicates whether to call the AuctionResolve method. The default value of True causes the method to be called with the bOptimize parameter of the method set to True. A value of False causes the Auction object to skip the automatic call to the AuctionResolve method.
bResolve[Visual Basic]
A Boolean that indicates whether to call the AuctionResolve method. A of True causes the method to be called with the bOptimize parameter of the method set to True. A value of False causes the Auction object to skip the automatic call to the AuctionResolve method. The default value is True.
unnamed parameter[C++]
[out, retval] Reserved for future use.

Return Values

[C++] This method returns an HRESULT indicating whether it completed successfully. See the Error Values section for more details.

[Visual Basic] The return value is reserved for future use. Ignore the return value.

Error Values

[C++] This method returns 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.

[Visual Basic] This method sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to standard COM 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. In particular, the Description property may contain a text description of the error.

Remarks

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