<< Click to Display Table of Contents >> Navigation:  Reference > SmtpMail > GetQueueSize Method

 

GetQueueSize method returns number of e-mail messages queued for sending.

 

Syntax

 

[Visual Basic]

---

Function GetQueueSize() As Long

 

Example:

 

numMessages = objSmtpMail.GetQueueSize

 

[VBScript]

---

Function GetQueueSize()

 

Example:

 

numMessages = objSmtpMail.GetQueueSize

 

[C#]

---

int GetQueueSize();

 

Example:

 

int numMessages = objSmtpMail.GetQueueSize();

 

[C++]

---

HRESULT GetQueueSize(LONG* pnumErrorCode);

 

Example:

 

int numMessages = spSmtpMail->GetQueueSize();

 

 

Parameters

 

None.

 

Return value

 

Returns number of messages in AddEmail queue.

 

Remarks

 

SendAsync method places a message into a message queue and exits. Afer that AddEmail starts sending messages from the queue using background thread(s). Use GetQueueSize method to get the number of messages queued for sending.