Chromium Embedded Framework (CEF)  117.1.0+ga287baf+chromium-117.0.5938.62
CefPostDataElement Class Referenceabstract

Class used to represent a single element in the request post data. More...

#include "include/cef_request.h"

Inheritance diagram for CefPostDataElement:
CefBaseRefCounted

Public Types

typedef cef_postdataelement_type_t Type
 Post data elements may represent either bytes or files. More...
 

Public Member Functions

virtual bool IsReadOnly ()=0
 Returns true if this object is read-only. More...
 
virtual void SetToEmpty ()=0
 Remove all contents from the post data element. More...
 
virtual void SetToFile (const CefString &fileName)=0
 The post data element will represent a file. More...
 
virtual void SetToBytes (size_t size, const void *bytes)=0
 The post data element will represent bytes. More...
 
virtual Type GetType ()=0
 Return the type of this post data element. More...
 
virtual CefString GetFile ()=0
 Return the file name. More...
 
virtual size_t GetBytesCount ()=0
 Return the number of bytes. More...
 
virtual size_t GetBytes (size_t size, void *bytes)=0
 Read up to |size| bytes into |bytes| and return the number of bytes actually read. More...
 
- Public Member Functions inherited from CefBaseRefCounted
virtual void AddRef () const =0
 Called to increment the reference count for the object. More...
 
virtual bool Release () const =0
 Called to decrement the reference count for the object. More...
 
virtual bool HasOneRef () const =0
 Returns true if the reference count is 1. More...
 
virtual bool HasAtLeastOneRef () const =0
 Returns true if the reference count is at least 1. More...
 

Static Public Member Functions

static CefRefPtr< CefPostDataElementCreate ()
 Create a new CefPostDataElement object. More...
 

Additional Inherited Members

- Protected Member Functions inherited from CefBaseRefCounted
virtual ~CefBaseRefCounted ()
 

Detailed Description

Class used to represent a single element in the request post data.

The methods of this class may be called on any thread.

Member Typedef Documentation

◆ Type

Post data elements may represent either bytes or files.

Member Function Documentation

◆ Create()

static CefRefPtr<CefPostDataElement> CefPostDataElement::Create ( )
static

Create a new CefPostDataElement object.

◆ GetBytes()

virtual size_t CefPostDataElement::GetBytes ( size_t  size,
void *  bytes 
)
pure virtual

Read up to |size| bytes into |bytes| and return the number of bytes actually read.

◆ GetBytesCount()

virtual size_t CefPostDataElement::GetBytesCount ( )
pure virtual

Return the number of bytes.

◆ GetFile()

virtual CefString CefPostDataElement::GetFile ( )
pure virtual

Return the file name.

◆ GetType()

virtual Type CefPostDataElement::GetType ( )
pure virtual

Return the type of this post data element.

◆ IsReadOnly()

virtual bool CefPostDataElement::IsReadOnly ( )
pure virtual

Returns true if this object is read-only.

◆ SetToBytes()

virtual void CefPostDataElement::SetToBytes ( size_t  size,
const void *  bytes 
)
pure virtual

The post data element will represent bytes.

The bytes passed in will be copied.

◆ SetToEmpty()

virtual void CefPostDataElement::SetToEmpty ( )
pure virtual

Remove all contents from the post data element.

◆ SetToFile()

virtual void CefPostDataElement::SetToFile ( const CefString fileName)
pure virtual

The post data element will represent a file.


The documentation for this class was generated from the following file: