PMDF popstore & MessageStore Manager's Guide
PMDF-POP-6.0

Previous | Contents

POPSTORE_message_mark_read

Mark a user's message as read.
FORMAT 
int POPSTORE_message_mark_read (user_context, message_index) 
      POPSTORE_user_context *user_context; 
      int                    message_index;

ARGUMENTS

user_context

User context created by a prior call to POPSTORE_user_begin_d. Used for input only.

message_index

Index of the message to mark as read. Used for input only.

DESCRIPTION

Use POPSTORE_message_mark_read to mark a user's stored message as being read. The index of the message to mark is specified with message_index. The first message has index 1, the second index 2, and so on. An example of using POPSTORE_message_mark_read is given in

Examples

12-8 .
Return Values
POPSTORE_SUCCESS Normal, successful completion.
POPSTORE_BADMSGID Message index is less than 1 or greater than user_context->message_count.
POPSTORE_NULLCONTEXT user_context context is null.
POPSTORE_NULLMSGLIST user_context->messages is null.
POPSTORE_NULLPROFILE user_context->profile context is null.

Previous | Next | Contents