OESTORE::IOEFolder Interface Reference

List of all members.

Public Member Functions

HRESULT CreateFolder ([in] BSTR name,[out, retval] long *)
HRESULT CreateMessage ([in] BSTR msgSource,[in, defaultvalue(0)] long status,[out, retval] OEMessage **)
HRESULT Delete ([out, retval] BOOL *)
HRESULT DeleteMessage ([in] long msgId,[in] BOOL permanent,[out, retval] BOOL *)
HRESULT GetFirstChild ([out, retval] OEFolder **)
HRESULT GetFirstMessage ([out, retval] OEMessage **)
HRESULT GetID ([out, retval] long *)
HRESULT GetMessage ([in] long msgId,[out, retval] OEMessage **)
HRESULT GetMessageCount ([out, retval] long *count)
HRESULT GetNextChild ([out, retval] OEFolder **)
HRESULT GetNextMessage ([out, retval] OEMessage **)
HRESULT GetSubFolderCount ([out, retval] long *count)
HRESULT GetUnreadCount ([out, retval] long *count)
HRESULT IsDeleted ([out, retval] BOOL *)
HRESULT IsDraft ([out, retval] BOOL *)
HRESULT IsInbox ([out, retval] BOOL *)
HRESULT IsNull ([out, retval] BOOL *)
HRESULT IsOutbox ([out, retval] BOOL *)
HRESULT IsSent ([out, retval] BOOL *)
HRESULT MarkAsRead ([in] long msgId,[out, retval] BOOL *)
HRESULT MarkAsUnread ([in] long msgId,[out, retval] BOOL *)
HRESULT Move ([in] long newParentId,[out, retval] BOOL *)
HRESULT Name ([out, retval] BSTR *bstrHi)
HRESULT Rename ([in] BSTR newName,[out, retval] BOOL *)

Member Function Documentation

HRESULT OESTORE::IOEFolder::CreateFolder ( [in] BSTR  name,
[out, retval] long *   
)

Creates a folder. If the function fails it returns -1. Otherwise, it returns the folderId of the new folder.

HRESULT OESTORE::IOEFolder::CreateMessage ( [in] BSTR  msgSource,
[in, defaultvalue(0)] long  status,
[out, retval] OEMessage **   
)

Create a new message in the folder. msgSource must contain all the source of the message.

HRESULT OESTORE::IOEFolder::Delete ( [out, retval] BOOL *   ) 

Deletes the folder. If the function returns TRUE the folder is no longer valid.

HRESULT OESTORE::IOEFolder::DeleteMessage ( [in] long  msgId,
[in] BOOL  permanent,
[out, retval] BOOL *   
)

Move the message to the 'Deleted items' folder, by id.
If permanent is TRUE the message is permanently deleted, instead of just moved to the 'Deleted items' folder.

HRESULT OESTORE::IOEFolder::GetFirstChild ( [out, retval] OEFolder **   ) 

Get first child folder. Returns NULL if there is no child folder.

HRESULT OESTORE::IOEFolder::GetFirstMessage ( [out, retval] OEMessage **   ) 

Get the folder's first message. Returns NULL if no message is found.

HRESULT OESTORE::IOEFolder::GetID ( [out, retval] long *   ) 

Get the folder's id.

HRESULT OESTORE::IOEFolder::GetMessage ( [in] long  msgId,
[out, retval] OEMessage **   
)

Get a folder's message by id. If the id does not match it returns NULL.

HRESULT OESTORE::IOEFolder::GetMessageCount ( [out, retval] long *  count  ) 

Gets the number of messages in the folder.
Returns -1 on error.

HRESULT OESTORE::IOEFolder::GetNextChild ( [out, retval] OEFolder **   ) 

Get next child folder. Returns NULL when finishes.

HRESULT OESTORE::IOEFolder::GetNextMessage ( [out, retval] OEMessage **   ) 

Get next message of the folder. Returns NULL when no message is found.

HRESULT OESTORE::IOEFolder::GetSubFolderCount ( [out, retval] long *  count  ) 

Gets the number of sub folders of the folder.
Returns -1 on error.

HRESULT OESTORE::IOEFolder::GetUnreadCount ( [out, retval] long *  count  ) 

Gets the number of unread messages in the folder.
Returns -1 on error.

HRESULT OESTORE::IOEFolder::IsDeleted ( [out, retval] BOOL *   ) 

Returns TRUE if it is the special folder Deleted items.

HRESULT OESTORE::IOEFolder::IsDraft ( [out, retval] BOOL *   ) 

Returns TRUE if it is the special folder Drafts.

HRESULT OESTORE::IOEFolder::IsInbox ( [out, retval] BOOL *   ) 

Returns TRUE if it is the special folder Inbox.

HRESULT OESTORE::IOEFolder::IsNull ( [out, retval] BOOL *   ) 

Verifies if it's a valid folder.

HRESULT OESTORE::IOEFolder::IsOutbox ( [out, retval] BOOL *   ) 

Returns TRUE if it is the special folder Outbox.

HRESULT OESTORE::IOEFolder::IsSent ( [out, retval] BOOL *   ) 

Returns TRUE if it is the special folder Sent items.

HRESULT OESTORE::IOEFolder::MarkAsRead ( [in] long  msgId,
[out, retval] BOOL *   
)

Marks the message as read.

HRESULT OESTORE::IOEFolder::MarkAsUnread ( [in] long  msgId,
[out, retval] BOOL *   
)

Marks the message as unread.

HRESULT OESTORE::IOEFolder::Move ( [in] long  newParentId,
[out, retval] BOOL *   
)

Moves the folder. Returns TRUE on success.

HRESULT OESTORE::IOEFolder::Name ( [out, retval] BSTR *  bstrHi  ) 

Get the folder's name.

HRESULT OESTORE::IOEFolder::Rename ( [in] BSTR  newName,
[out, retval] BOOL *   
)

Renames the folder. Returns TRUE on success.



Developed by Nektra