Data Structures
class	FileInputStream
	Class implementing an InputStream reading from a file. More...

class	FileOutputStream
	Class implementing an OutputStream writing to a file. More...

class	InputStream
	Interface for an input stream, inspired by Java's java.io.InputStream. More...

class	LibraryInputStream
	Base class for InputStream implementations in SignDoc SDK. More...

class	LibraryOutputStream
	Base class for OutputStream implementations in SignDoc SDK. More...

class	LibrarySignDocCaptureDevice
	SignDocCaptureDevice implemented in SignDoc SDK. More...

class	LibrarySignDocCaptureDisplay
	SignDocCaptureDisplay implemented in SignDoc SDK. More...

class	LibrarySignDocCaptureListener
	SignDocCaptureListener implemwented in SignDoc SDK. More...

class	LibraryTimeStamper
	TimeStamper implemented in SignDoc SDK. More...

class	MemoryInputStream
	Class implementing an InputStream reading from memory. More...

class	MemoryOutputStream
	Class implementing an OutputStream writing to memory and allocating memory as needed. More...

class	OutputStream
	Interface for an output stream, inspired by Java's java.io.OutputStream. More...

class	Point
	A point (document coordinates or canvas coordinates depending on context). More...

class	Rect
	A rectangle (document coordinates). More...

class	SignDocAnnotation
	An annotation. More...

class	SignDocAttachment
	Output of SignDocDocument::getAttachment(). More...

class	SignDocCapture
	Capture signatures. More...

class	SignDocCaptureDevice
	Interface for a capture device. More...

class	SignDocCaptureDisplay
	Interface for displaying a background image and painting strokes while capturing. More...

class	SignDocCaptureDisplayEventListener
	Interface reporting resize and move events for GUI elements. More...

class	SignDocCaptureFilters
	Filters for enumerating capture devices. More...

class	SignDocCaptureListener
	Interface for receiving captured samples and other events. More...

class	SignDocCaptureOutput
	Result of SignDocCapture::waitCapture(). More...

class	SignDocCaptureParameters
	Parameters for SignDocCapture::startCapture(). More...

class	SignDocCaptureResult
	Output of SignDocCapture::waitCapture2(). More...

class	SignDocCaptureTransformation
	Output of SignDocCaptureDevice::getTransformation(). More...

class	SignDocCaptureVirtualButton
	A virtual button. More...

class	SignDocChange
	A single change made to a PDF document after a signature. More...

class	SignDocCheckSignatureParameters
	Parameters for SignDocSignatureData::checkReference() and SignDocSignatureData::checkSignature(). More...

class	SignDocCleanParameters
	Actions and parameters for SignDocImage::clean(). More...

class	SignDocColor
	A color. More...

class	SignDocDocument
	An interface for SignDoc documents. More...

class	SignDocDocumentHandler
	Handler for one document type (internal interface). More...

class	SignDocDocumentLoader
	Create SignDocDocument objects. More...

class	SignDocField
	One field of a document. More...

class	SignDocFindTextOccurrence
	Information about text found by SignDocDocument::findText(). More...

class	SignDocImage
	A bitmap image. More...

class	SignDocImageParameters
	Parameters for saving images, converting images to bi-level images, and rendering biometric signatures as images. More...

class	SignDocImageRect
	A rectangle for use with SignDocImage. More...

class	SignDocMatchParameters
	Parameters for SignDocSignatureData::matchSignature(), SignDocSignatureData::matchReference(), SignDocImage::matchSignature(), and SignDocImage::matchReference(). More...

class	SignDocMatchResult
	Result of SignDocSignatureData::matchSignature(), SignDocSignatureData::matchReference(), SignDocImage::matchSignature(), and SignDocImage::matchReference(). More...

class	SignDocPdfDocumentHandler
	SignDoc document handler for PDF documents. More...

class	SignDocProperty
	One property, without value. More...

class	SignDocRenderOutput
	Output of SignDocDocument::renderPageAsImage() and SignDocDocument::renderPageAsSignDocImage(). More...

class	SignDocRenderParameters
	Parameters for SignDocDocument::renderPageAsImage() and SignDocDocument::renderPageAsSignDocImage(). More...

class	SignDocSignature
	Information about a signature field returned by SignDocDocument::getSignature(). More...

class	SignDocSignatureData
	Biometric data of handwritten signatures. More...

class	SignDocSignatureParameters
	Parameters for signing a document. More...

class	SignDocSignatureSample
	A single sample of the biometric data of a handwritten signature. More...

class	SignDocTextCluster
	A cluster of Unicode code points and glyphs. More...

class	SignDocTextFieldAttributes
	Attributes of a text field, list box field or combo box field used for the construction of the appearance (PDF documents only). More...

class	SignDocTextIterator
	An iterator for the text of a document. More...

class	SignDocTiffDocumentHandler
	SignDoc document handler for TIFF documents. More...

class	SignDocVerificationParameters
	Parameters for verifying a certificate chain. More...

class	SignDocVerificationResult
	Information about a signature field returned by SignDocDocument::verifySignature() or SignDocDocument::verifySignature2(). More...

class	SignDocWatermark
	Parameters for a watermark. More...

class	SignDocWeightedFrame
	A frame and its weight. More...

class	SignECDSA
	Interface for creating an ECDSA signature. More...

class	SignPKCS7
	Interface for creating a PKCS #7 or CAdES signature. More...

class	SignRSA
	Interface for creating an RSA signature. More...

class	Source
	Data source. More...

class	TimeStamper
	Interface for creating an RFC 3161 timestamp. More...

class	UserInputStream
	Base class for InputStream implementations by user code. More...

class	UserOutputStream
	Base class for OutputStream implementations by user code. More...

class	UserSignDocCaptureDevice
	Base class for SignDocCaptureDevice implementations by user code. More...

class	UserSignDocCaptureDisplay
	Base class for SignDocCaptureDisplay implementations by user code. More...

class	UserSignDocCaptureListener
	Base class for SignDocCaptureListener implemented by user code. More...

class	UserTimeStamper
	Bsae class for user-provided timestamping. More...

Enumerations
enum	ReturnCode { rc_ok, rc_invalid_argument, rc_field_not_found, rc_invalid_profile, rc_invalid_image, rc_type_mismatch, rc_font_not_found, rc_unused_7, rc_not_supported, rc_io_error, rc_not_verified, rc_property_not_found, rc_page_not_found, rc_wrong_collection, rc_field_exists, rc_license_error, rc_unexpected_error, rc_cancelled, rc_no_biometric_data, rc_unused_19, rc_field_not_signed, rc_invalid_signature, rc_annotation_not_found, rc_attachment_not_found, rc_attachment_exists, rc_no_certificate, rc_ambiguous_certificate, rc_not_allowed, rc_invalid_structure, rc_unknown_parameter, rc_invalid_value, rc_not_available, rc_no_capture_device, rc_wrong_state }
	Return codes. More...

enum	Encoding { enc_native, enc_utf_8, enc_latin_1 }
	Encoding of strings. More...

Functions
void	SignDoc_throw (SIGNDOC_Exception *aEx)
	Internal function. More...

void	SIGNDOC_catch (SIGNDOC_Exception **aEx, std::exception &aInput)
	Internal function. More...

SignDocVerificationResult *	makeSignDocVerificationResult (SIGNDOC_VerificationResult *aP)
	Internal function. More...

void	assignArray (std::vector< unsigned char > &aDst, SIGNDOC_ByteArray *aSrc)
	Internal function. More...

void	assignArray (std::vector< std::vector< unsigned char > > &aDst, SIGNDOC_ByteArrayArray *aSrc)
	Internal function. More...

void	assignArray (std::vector< int > &aDst, SIGNDOC_IntArray *aSrc)
	Internal function. More...

void	assignArray (std::vector< std::string > &aDst, SIGNDOC_StringArray *aSrc)
	Internal function. More...

void	assignArray (std::vector< Rect > &aDst, SIGNDOC_RectArray *aSrc)
	Internal function. More...

void	assignArray (std::vector< SignDocField > &aDst, SIGNDOC_FieldArray *aSrc)
	Internal function. More...

void	assignArray (std::vector< SignDocProperty > &aDst, SIGNDOC_PropertyArray *aSrc)
	Internal function. More...

void	assignArray (std::vector< SignDocFindTextOccurrence > &aDst, SIGNDOC_FindTextOccurrenceArray *aSrc)
	Internal function. More...

void	assignArray (std::vector< SignDocWeightedFrame > &aDst, SIGNDOC_WeightedFrameArray *aSrc)
	Internal function. More...

Enumeration Type Documentation

enum Encoding

Encoding of strings.

Enumerator
enc_native	Windows "ANSI" for Windows, LC_CTYPE for Linux, file system representation for iOS.
enc_utf_8	UTF-8.
enc_latin_1	ISO 8859-1.

enum ReturnCode

strong

Return codes.

Enumerator
rc_ok	No error (0). The operation completed successfully.
rc_invalid_argument	Invalid argument (1). An invalid value was passed for at least one parameter. This return code can also be returned for invalid documents.
rc_field_not_found	Field not found (2). The specified field does not exist or (if a signature field is expected) is not a signature field.
rc_invalid_profile	Invalid profile (3). The specified profile is unknown or not applicable.
rc_invalid_image	Invalid image (4). The specified image cannot be used. This can happen if the image's format is unsupported or if the image is broken.
rc_type_mismatch	Type mismatch (5). The type (e.g., string) implied by the function does not match the type of the named property.
rc_font_not_found	Font not found (6). The requested font could not be found or does not contain all required characters. See also SignDocDocument::setShootInFoot(), SignDocDocumentLoader::loadFontConfigBlob(), SignDocDocumentLoader::loadFontConfigEnvironment(), SignDocDocumentLoader::loadFontConfigFile(), SignDocDocumentLoader::loadFontConfigStream()
rc_unused_7	Unused return code (7).
rc_not_supported	Operation not supported (8). In most cases, this return code indicates invalid data (such as broken or unsupported biometric data). For SignDocCaptureDevice::createDisplay(), this error code means that the capture device has no suitable display.
rc_io_error	I/O error (9). An error occurred while trying to open, read, or write a file.
rc_not_verified	Signature not verified (10). This code is returned by member functions of SignDocVerificationResult if verifySignature() has not been called.
rc_property_not_found	Property not found (11). The specified property does not exist. SignDocSignatureData::getDeviceSize(): The minimum and maximum coordinates of the capture device are not available.
rc_page_not_found	Page not found (12). The specified page number is not a valid page number.
rc_wrong_collection	Wrong collection (13). The specified property exists, but not in the specified collection.
rc_field_exists	Field already exists (14). Field names must be unique.
rc_license_error	License error (15) License initialization failed (missing or invalid license key) or license check failed (you don't have a license for the requested operation).
rc_unexpected_error	Unexpected error (16). Something failed in an unexpected way or there's no return code that fits the failure.
rc_cancelled	Operation cancalled (17). Certificate selection dialog cancelled by user.
rc_no_biometric_data	No biometric data (18). This code is returned by member functions of SignDocVerificationResult if there is no biometric data or no biometric hash.
rc_unused_19	Unused return code (19).
rc_field_not_signed	Field not signed (20). Returned by copyAsSignedToStream() and copyAsSignedToMemory() if the field is not signed.
rc_invalid_signature	Signature is not valid (21). Returned by addSignature(), copyAsSignedToMemory(), copyAsSignedToStream(), updateDSS(), and updateDSS2().
rc_annotation_not_found	Annotation not found (22). Returned by getAnnotation().
rc_attachment_not_found	Attachment not found (23).
rc_attachment_exists	Attachment already exists (24).
rc_no_certificate	No certificate found (25). No (matching) certificate found and SignDocSignatureParameters::csf_create_self_signed is not specified.
rc_ambiguous_certificate	Ambiguous certificate (26). More than one matching certificate found and SignDocSignatureParameters::csf_never_ask is specified.
rc_not_allowed	Operation not allowed (27). Operation not allowed due to document being signed or conforming to PDF/A or PDF/UA or having logical structure. See also SignDocDocument::removePDFA(), SignDocDocument::removePDFUA(), SignDocDocument::setShootInFoot().
rc_invalid_structure	Invalid logical structure (28). The document has invalid logical structure. See also SignDocDocument::f_fail_for_broken_target_structure
rc_unknown_parameter	Unknown parameter (29). The specified parameter (aName) is unknown. For SignDocCaptureDevice, SignDocCheckSignatureParameters, SignDocCleanParameters, SignDocImageParameters, SignDocMatchParameters, SignDocRenderParameters, SignDocSignatureParameters, and SignDocVerificationParameters.
rc_invalid_value	Invalid value (30). The specified value (aValue) is invalid. For SignDocCaptureDevice, SignDocCheckSignatureParameters, SignDocCleanParameters, SignDocImageParameters, SignDocMatchParameters, SignDocRenderParameters, SignDocSignatureParameters, and SignDocVerificationParameters.
rc_not_available	Not available (31). The requested value is not available. This code is returned by some member functions of SignDocAnnotation for objects returned by getAnnotation().
rc_no_capture_device	No capture device found (32). No capture device matching the specified filters has been found. See also SignDocCapture::createDefaultDevice()
rc_wrong_state	Wrong state (33). The current state of the SignDocCaptureDevice object does not allow the requested operation.

Function Documentation

void de::softpro::doc::assignArray	(	std::vector< unsigned char > &	aDst,
		SIGNDOC_ByteArray *	aSrc
	)

inline

Internal function.

void de::softpro::doc::assignArray	(	std::vector< std::vector< unsigned char > > &	aDst,
		SIGNDOC_ByteArrayArray *	aSrc
	)

inline

Internal function.

void de::softpro::doc::assignArray	(	std::vector< int > &	aDst,
		SIGNDOC_IntArray *	aSrc
	)

inline

Internal function.

void de::softpro::doc::assignArray	(	std::vector< std::string > &	aDst,
		SIGNDOC_StringArray *	aSrc
	)

inline

Internal function.

void de::softpro::doc::assignArray	(	std::vector< Rect > &	aDst,
		SIGNDOC_RectArray *	aSrc
	)

inline

Internal function.

void de::softpro::doc::assignArray	(	std::vector< SignDocField > &	aDst,
		SIGNDOC_FieldArray *	aSrc
	)

inline

Internal function.

void de::softpro::doc::assignArray	(	std::vector< SignDocProperty > &	aDst,
		SIGNDOC_PropertyArray *	aSrc
	)

inline

Internal function.

void de::softpro::doc::assignArray	(	std::vector< SignDocFindTextOccurrence > &	aDst,
		SIGNDOC_FindTextOccurrenceArray *	aSrc
	)

inline

Internal function.

void de::softpro::doc::assignArray	(	std::vector< SignDocWeightedFrame > &	aDst,
		SIGNDOC_WeightedFrameArray *	aSrc
	)

inline

Internal function.

SignDocVerificationResult * makeSignDocVerificationResult ( SIGNDOC_VerificationResult * aP )

inline

Internal function.

void de::softpro::doc::SIGNDOC_catch	(	SIGNDOC_Exception **	aEx,
		std::exception &	aInput
	)

inline

Internal function.

void de::softpro::doc::SignDoc_throw ( SIGNDOC_Exception * aEx )

inline

Internal function.

Data Structures

Enumerations

Functions

Enumeration Type Documentation

Function Documentation