<< Click to Display Table of Contents >>

 

zetafax_logo

ZfxMarkMsgAsRead

 


 

Marks message as 'read' (changes the user status of the message).

 

Syntax

 

ZFERR FAR ZfxMarkMsgAsRead( ZFSESSIONHANDLE hSession, ZFMSGDIR MsgDir, char FAR  *lpszBody)

 

Parameters

 

Parameter

Description

Hsession

API session handle, as returned by ZfxAPIInit  call MsgDir Message type (ZFDIR_OUT)LpszBodyBase name of message file

 

Description

 

This routine is called to mark a specified message as 'read'. It updates the user staus of the message in the control files so does not need to send any requests to the Zetafax Server.

 

Return value

 

The routine returns 0 if successful, otherwise one of the following:

 

ZFERR_NOT_INITIALISED

ZFERR_INVALID_PARAMETERS

ZFERR_UNKNOWN_MESSAGE

ZFERR_SERVER_NOT_RUNNING

 

Example

 

#include  <stdio.h>

#include <zfapi.h>

...

if (ZfxMarkMsgAsRead(hSession, ZFDIR_OUT, "~XSND000") == 0)

{

  printf("Message marked as read\n");

  /* viewing the user's message */

  /*in the client would now show */

  /* the message as being read */

  ...

}

 

Related topics

Alphabetical reference

Function error returns and reference