Visual Basic Code Example: Retrieving MSMQQueueInfo.Label

 

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 queue and returns the PROPID_Q_LABEL property for it.

This function can return the label of a local private queue from information stored on the local computer, but must retrieve information stored in the directory service to return the label of a local or remote public queue. This function cannot be used to obtain the label of a remote private queue.

To retrieve MSMQQueueInfo.Label

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

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

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.

1. Return the local setting of MSMQQueueInfo.Label.

Code Example

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

Function GetQueueLabel( _  
                       strPathname As String _  
                       ) As String  
  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 setting of MSMQQueueInfo.Label.  
  GetQueueLabel = qinfo.Label  
  Exit Function  
  
ErrorHandler:  
  MsgBox "Error " + Hex(Err.Number) + " was returned." _  
          + Chr(13) + Err.Description  
End Function