Gjsify LogoGjsify Logo

Hierarchy

  • ContentsReadFunc

Callable

  • ContentsReadFunc(contents: Contents, buffer: object, length: number): boolean
  • This callback is used to retrieve the next chunk of data for a streaming contents buffer created with #epc_contents_stream_read.

    Return %FALSE when the buffer has reached its end, and no more data is available. Also return %FALSE, when the buffer size passed in length is not sufficient. Copy your minimal buffer size to length in that situation.

    The library might pass %NULL for buffer on the first call to start buffer size negotation.

    See also: #epc_contents_stream_new, #epc_contents_stream_read

    Parameters

    • contents: Contents

      a #EpcContents buffer

    • buffer: object

      a location for storing the contents, or %NULL

    • length: number

      a location for passing and storing the contents length in bytes.

    Returns boolean

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method