FileStructureIssueHandle Class Reference

Represents a single structural issue found during validation. More...

Inheritance diagram for FileStructureIssueHandle:

error_type CALLING_CONVENTION	FileStructureIssue_GetSeverity (FileStructureIssueHandle *handle, FileStructureIssueSeverityType *result)
	Get the severity of the issue.
error_type CALLING_CONVENTION	FileStructureIssue_GetCode (FileStructureIssueHandle *handle, FileStructureIssueCodeType *result)
	Get the issue code.
error_type CALLING_CONVENTION	FileStructureIssue_GetMessage (FileStructureIssueHandle *handle, BufferHandle **result)
	Get the human-readable issue message.
error_type CALLING_CONVENTION	FileStructureIssue_HasObjectContext (FileStructureIssueHandle *handle, boolean_type *result)
	Check whether this issue carries an object context (object and generation number).
error_type CALLING_CONVENTION	FileStructureIssue_GetObjectNumber (FileStructureIssueHandle *handle, biguint_type *result)
	Get the object number associated with this issue.
error_type CALLING_CONVENTION	FileStructureIssue_GetGenerationNumber (FileStructureIssueHandle *handle, ushort_type *result)
	Get the generation number associated with this issue.
error_type CALLING_CONVENTION	FileStructureIssue_ToUnknown (FileStructureIssueHandle *handle, IUnknownHandle **result)
	Reinterpret current object as IUnknownHandle.
error_type CALLING_CONVENTION	FileStructureIssue_FromUnknown (IUnknownHandle *handle, FileStructureIssueHandle **result)
	Convert IUnknownHandle to FileStructureIssueHandle.
error_type CALLING_CONVENTION	FileStructureIssue_Release (FileStructureIssueHandle *handle)
	Decrement the internal reference counter.

Additional Inherited Members
Public Member Functions inherited from IUnknownHandle
error_type CALLING_CONVENTION	IUnknown_AddRef (IUnknownHandle *handle)
	Increment the internal reference counter.
Related Symbols inherited from IUnknownHandle
error_type CALLING_CONVENTION	IUnknown_Release (IUnknownHandle *handle)
	Decrement the internal reference counter.

Detailed Description

Represents a single structural issue found during validation.

Friends And Related Symbol Documentation

FileStructureIssue_HasObjectContext()

error_type CALLING_CONVENTION FileStructureIssue_HasObjectContext ( FileStructureIssueHandle *  handle, boolean_type *  result  )

related

Check whether this issue carries an object context (object and generation number).

Note

Call this before FileStructureIssue_GetObjectNumber or FileStructureIssue_GetGenerationNumber. File-level issues have no object context.

FileStructureIssue_GetObjectNumber()

error_type CALLING_CONVENTION FileStructureIssue_GetObjectNumber ( FileStructureIssueHandle *  handle, biguint_type *  result  )

related

Get the object number associated with this issue.

Note

Returns VANILLAPDF_ERROR_OBJECT_MISSING if the issue has no object context. Check FileStructureIssue_HasObjectContext first.

FileStructureIssue_GetGenerationNumber()

error_type CALLING_CONVENTION FileStructureIssue_GetGenerationNumber ( FileStructureIssueHandle *  handle, ushort_type *  result  )

related

Get the generation number associated with this issue.

Note

Returns VANILLAPDF_ERROR_OBJECT_MISSING if the issue has no object context. Check FileStructureIssue_HasObjectContext first.

FileStructureIssue_Release()

error_type CALLING_CONVENTION FileStructureIssue_Release ( FileStructureIssueHandle *  handle )

related

Decrement the internal reference counter.

When the internal counter reaches zero the object is deleted. Releasing already disposed object causes undefined behavior.

See also

IUnknown_Release

---

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

• c_file_structure_validator.h