Output of SignDocDocument::getAttachment().
More...
#include <SignDocSDK-cpp.h>
Copy constructor.
- Parameters
-
[in] | aSource | The object to be copied. |
int getCompressedSize |
( |
| ) |
const |
|
inline |
Get the compressed size (in octets) of the attachment.
- Returns
- The compressed size (in octets) of the attachment.
- See also
- getSize()
const char * getCreationTime |
( |
| ) |
const |
|
inline |
Get the creation time and date of the attachment.
The returned string will be empty if the creation time and date are missing.
ISO 8601 format is used: yyyy-mm-ddThh:mm:ss, optionally followed by a timezone: Z, +hh:mm, or -hh:mm.
The PDF reference is ambiguous; apparently, the creation time is supposed to be the time and date at which the attachment was the PDF document. Changing the description does not update the modification date/time.
- Returns
- The creation time and date of the attachment. This pointer will become invalid when this object is destroyed.
- See also
- getModificationTime()
std::string getDescription |
( |
Encoding |
aEncoding | ) |
const |
|
inline |
Get the description of the attachment.
The returned string will be empty if the description is missing.
This function throws std::runtime_error if the description cannot be represented using the specified encoding.
- Parameters
-
[in] | aEncoding | The encoding to be used for the return value. |
- Returns
- The description of the attachment.
- See also
- getDescriptionUTF8()
const char * getDescriptionUTF8 |
( |
| ) |
const |
|
inline |
Get the description of the attachment as UTF-8-encoded C string.
The returned string will be empty if the description is missing.
- Returns
- The description of the attachment. This pointer will become invalid when this object is destroyed.
- See also
- getDescription()
std::string getFileName |
( |
Encoding |
aEncoding | ) |
const |
|
inline |
Get the file name of the attachment.
This function throws std::runtime_error if the file name cannot be represented using the specified encoding.
- Parameters
-
[in] | aEncoding | The encoding to be used for the return value. |
- Returns
- The file name of the attachment.
- See also
- getFileNameUTF8()
const char * getFileNameUTF8 |
( |
| ) |
const |
|
inline |
Get the file name of the attachment as UTF-8-encoded C string.
- Returns
- The file name of the attachment. This pointer will become invalid when this object is destroyed.
- See also
- getFileName()
SIGNDOC_Attachment* getImpl |
( |
| ) |
|
|
inline |
const SIGNDOC_Attachment* getImpl |
( |
| ) |
const |
|
inline |
const char * getModificationTime |
( |
| ) |
const |
|
inline |
Get the time and date of the last modification of the attachment.
Setting the time and date of the last modification of the attachment is optional. The returned string will be empty if the modification time and date are missing.
ISO 8601 format is used: yyyy-mm-ddThh:mm:ss, optionally followed by a timezone: Z, +hh:mm, or -hh:mm.
The PDF reference is ambiguous; apparently, the modification time is supposed to be the time and date of the last modification of the file at the time it was attached. Changing the description does not update the modification date/time.
- Returns
- The time and date of the last modification of the attachment. This pointer will become invalid when this object is destroyed.
std::string getName |
( |
Encoding |
aEncoding | ) |
const |
|
inline |
Get the name of the attachment.
This function throws std::runtime_error if the name cannot be represented using the specified encoding.
- Parameters
-
[in] | aEncoding | The encoding to be used for the return value. |
- Returns
- The name of the attachment.
- See also
- getNameUTF8()
const char * getNameUTF8 |
( |
| ) |
const |
|
inline |
Get the name of the attachment as UTF-8-encoded C string.
- Returns
- The name of the attachment. This pointer will become invalid when this object is destroyed.
- See also
- getName()
Get the size (in octets) of the attachment.
The return value is -1 if the size of the attachment is not readily available.
- Returns
- The size (in octets) of the attachment or -1.
- See also
- getCompressedSize()
const char * getType |
( |
| ) |
const |
|
inline |
Get the MIME type of the attachment.
The return string will be empty if the MIME type is missing.
- Returns
- The MIME type of the attachment. This pointer will become invalid when this object is destroyed.
Assignment operator.
- Parameters
-
[in] | aSource | The source object. |
- Returns
- This object.
void setImpl |
( |
SIGNDOC_Attachment * |
aP | ) |
|
|
inline |
Efficiently swap this object with another one.
- Parameters
-
[in] | aOther | The other object. |
The documentation for this class was generated from the following file: