Partager via

IObexDevice::Put

  • Article

This method issues a Put command for an object that is passed to the server.

HRESULT Put(
  IHeaderCollection* pHeaders, 
  IStream** ppStream
);

Parameters

  • pHeaders
    [in] Pointer to the headers collection that describes the object.
  • ppStream
    [out] Unique. Destination pointer to the IStream interface, which is used to write the data.

Return Values

The appropriate HResult is returned.

Remarks

To verify the Put operation has completed, run IStream::Commit before you close the operation. This practice is particularly useful when deleting a file. A return of S_OK indicates the operation has completed successfully.

The following code example shows how to delete a file after the put operation has completed. This example assumes the existence of an IObexDevice object that is named pObexDevice and is correctly initialized. It also assumes that an IHeaderCollection object, named pHeaderCollection, is initialized.

//
// A PUT operation that has BODY is assumed by the 
// server to be a delete  (per IrOBEX 1.2 spec section 3.3.3.6).
// This example demonstrates how to use the WinCE OBEX client 
// implementation to delete a file.

//
//  ---The construction/connection code of IObex/IObexDevice has been
//  omitted for brevity.
//

IStream *pStream = NULL;
if(FAILED(pHeaderCollection->AddName(L"MyFile.txt")) 
   goto Error;
if(FAILED(pObexDevice->Put(pHeaderCollection, &pStream)) {
   goto Error;

// NOTE: If Commit fails, the delete operation was either 
// rejected by the server or the connection was lost. 
// In either case, the file deletion failed.

if(FAILED(pStream->Commit(0))  
   goto Error;

//Success return.
hRet = S_OK;
goto Done;

Error:
    //Display Error and go to cleanup code.
    hRet = E_FAIL;
Done:
    //Clean up.

Requirements

OS Versions: Windows CE .NET 4.0 and later.
Header: Obex.h, Obex.idl.
Link Library: Uuid.lib.

See Also

Client Support | IObexDevice | IStream | OBEX Interfaces

 Last updated on Friday, April 09, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.