rwlogo
SourcePro C++ 12.0

SourcePro® C++ API Reference Guide



   SourcePro C++
Documentation Home

RWMimeContentDescriptionHeader Class Reference
[MIME]

Represents the Content-Description header of a MIME part. More...

#include <rw/mime/RWMimeContentDescriptionHeader.h>

Inheritance diagram for RWMimeContentDescriptionHeader:
RWMimeHeader RWHandleBase

List of all members.

Public Member Functions

 RWMimeContentDescriptionHeader (void)
 RWMimeContentDescriptionHeader (const RWCString &description)
 RWMimeContentDescriptionHeader (const RWMimeContentDescriptionHeader &second)
 RWMimeContentDescriptionHeader (const RWMimeHeader &second)
RWMimeContentDescriptionHeaderoperator= (const RWMimeContentDescriptionHeader &second)
virtual ~RWMimeContentDescriptionHeader (void)
RWCString getDescription (void) const
void setDescription (const RWCString &description)

Static Public Attributes

static const RWCString Label

Protected Member Functions

virtual bool checkLabel (const RWCString &label) const
RWMimeUnstructuredHeaderImp & body (void) const

Detailed Description

RWMimeContentDescriptionHeader represents the Content-Description header of a MIME part. The Content-Description provides a short text description of the contents of the message part. For example, a MIME message containing a sales report might contain the Content-Description header

 Content-Description: Sales report for last quarter.

An instance of this class is a handle to a private, reference-counted body.

Reference

RWMimeContentDescriptionHeader conforms to the Content-Description header requirements specified in RFC 2045, Section 8 (p. 27).


Constructor & Destructor Documentation

RWMimeContentDescriptionHeader::RWMimeContentDescriptionHeader ( void   ) 

Default constructor. Constructs a header with an empty value.

RWMimeContentDescriptionHeader::RWMimeContentDescriptionHeader ( const RWCString description  ) 

Constructs a header with the value description. Does not validate description. The description provided must be in US-ASCII format or be encoded according to the guidelines in RFC 2047 for the header to meet the requirements of the Internet Message Format specification. The RWCString should contain 7-bit US-ASCII data.

RWMimeContentDescriptionHeader::RWMimeContentDescriptionHeader ( const RWMimeContentDescriptionHeader second  ) 

Copy constructor. Constructs a new handle to the body second refers to.

RWMimeContentDescriptionHeader::RWMimeContentDescriptionHeader ( const RWMimeHeader second  ) 

Conversion constructor. Constructs a new handle to the body second refers to. Throws RWMimeError if second does not have the label "Content-Description".

virtual RWMimeContentDescriptionHeader::~RWMimeContentDescriptionHeader ( void   )  [virtual]

Destructor.


Member Function Documentation

RWMimeUnstructuredHeaderImp& RWMimeContentDescriptionHeader::body ( void   )  const [protected]

Returns a reference to the underlying implementation.

Reimplemented from RWMimeHeader.

virtual bool RWMimeContentDescriptionHeader::checkLabel ( const RWCString label  )  const [protected, virtual]

Returns true if label matches "Content-Description", false otherwise. The comparison is case-insensitive. The RWCString should contain 7-bit US-ASCII data.

Reimplemented from RWMimeHeader.

RWCString RWMimeContentDescriptionHeader::getDescription ( void   )  const

Returns the content description value contained within this header. The RWCString should contain 7-bit US-ASCII data.

RWMimeContentDescriptionHeader& RWMimeContentDescriptionHeader::operator= ( const RWMimeContentDescriptionHeader second  ) 

Assignment operator. Makes self a handle identical to second.

void RWMimeContentDescriptionHeader::setDescription ( const RWCString description  ) 

Sets the content description value contained within this header. The RWCString should contain 7-bit US-ASCII data.


Member Data Documentation

Static constant string containing "Content-Description", the label for a Content-Description header. The RWCString should contain 7-bit US-ASCII data.

 All Classes Functions Variables Typedefs Enumerations Enumerator Friends

© Copyright Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave and SourcePro are registered trademarks of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.
Contact Rogue Wave about documentation or support issues.