Visual Basic Code Example: Retrieving MSMQQueueInfo.BasePriority

 

Applies To: Windows 10, Windows 7, Windows 8, Windows 8.1, Windows Server 2008, Windows Server 2008 R2, Windows Server 2012, Windows Server 2012 R2, Windows Server Technical Preview, Windows Vista

This example provides a function that receives the path name of an existing public queue and returns the MSMQQueueInfo.BasePriority property for it, which can be used to display the base priority level of the queue.

This function must retrieve information stored in the directory service to return the base priority of an existing public queue.

To retrieve MSMQQueueInfo.BasePriority

1. Declare the objects needed to retrieve queue properties. This routine declares an MSMQQueueInfoobject.

2. Create the MSMQQueueInfo object. This example then uses MSMQQueueInfo.PathName to set the path name to the string passed to the function.

3. Call MSMQQueueInfo.Refresh to obtain the current registered settings of the queue properties. Note that this call retrieves the settings of all properties of the queue with the path name set. If no such queue exists, an error message is displayed.

4. Return the local setting of MSMQQueueInfo.BasePriority.

Code Example

The following code example can be run on all versions of Message Queuing.

Function GetBasePriority( _  
                         strPathname As String _  
                         ) As Long  
  Dim qinfo As MSMQQueueInfo  
  
  ' Create the MSMQQueueInfo object.  
  Set qinfo = New MSMQQueueInfo  
  qinfo.PathName = strPathname  
  On Error GoTo ErrorHandler  
  
  ' Retrieve the internally registered property values.  
  qinfo.Refresh  
  
  ' Return the local value of MSMQQueueInfo.BasePriority.  
  GetBasePriority = qinfo.BasePriority  
  Exit Function  
  
ErrorHandler:  
  MsgBox "Error " + Hex(Err.Number) + " was returned." _  
          + Chr(13) + Err.Description  
End Function