fpGetRestrictionsStream()

This function gets document restrictions from an input stream. For more information about this feature see Document Restrictions.

DEPRECATED: The fpGetRestrictionsStream() function is deprecated in KeyView 23.2.0 and later. OpenText recommends that you create a KVDocument to represent each document, and use fpGetRestrictions() instead.

This function is still available for existing implementations, but it might be incompatible with new functionality and might be removed in future.

Syntax

KVErrorCode pascal fpGetRestrictionsStream(
    KVFilterSession session,
    KVInputStream*  pInput,
    KVRestrictions* pRestrictions); 

Arguments

session

A KeyView Filter session that you initialized by calling fpInit().

pInput A pointer to the input stream.
pRestrictions A pointer to the KVRestrictions structure. Use the macro KVStructInit to initialize the KVStructHead structure before calling this function.

Returns

The return value is an error code. See KVErrorCode.

Discussion

  • This function runs in-process or out-of-process. See The Filter Process Model.
  • Restrictions can be reported for DOCX, XLSX, PPTX, and PDF format only.
  • Restrictions may not be reported if reading the document content is itself restricted.