mimeReaderMoveToNextEntity

 

SYNOPSIS

int mimeReaderMoveToNextEntity(mimeReader reader)

Parameters:

  • reader - A mimeReader object

Returns:

  • int value: 1 on success, 0 on EOF, -1 on error


DESCRIPTION
The mimeReaderMoveToNextEntity function moves the reader cursor (current entity location) to the next entity in the message. It returns 1 if successful (new entity reached), 0 if end of message (no more entities), or -1 on error. The entities will be traversed in message order, i.e. pre-order.


EXAMPLE

  <$reader = (mimeReaderOpenFile("/tmp/someMessage"))>
  <while (mimeReaderMoveToNextEntity($reader) = '1')>
    ... print current entity ...
  </while>


SEE ALSO
mimeReaderMoveToNextEntitySibling


Copyright © Thunderstone Software     Last updated: Dec 10 2018
Copyright © 2019 Thunderstone Software LLC. All rights reserved.