Visual Basic Code Example: Setting MSMQQueueInfo.Authenticate

  • Article

 

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 private Sub procedure that sets the MSMQQueueInfo.Authenticate property of an existing queue based on a given authentication level. Setting this property changes how the queue will handle new messages sent to the queue. Setting this property has no effect on messages already in the queue.

For information on how Message Queuing authenticates messages, see Message Authentication.

When Message Queuing updates the properties of a queue, their values are stored in one of two places. For public queues, these property values are stored in the directory service. For local private queues, these property values are stored on the local computer.

To set MSMQQueueInfo.Authenticate

  1. Declare the objects needed to update queue properties. This procedure 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. Optional. Call MSMQQueueInfo.Refresh to obtain the current registered settings of the queue properties. Note that this call retrieves any changes made by other applications.

  4. Set the MSMQQueueInfo.Authenticate property.

  5. Call MSMQQueueInfo.Update to register the new settings.

Code Example

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

Sub SetAuthenticationLevel( _  
                           strPathname As String, _  
                           lAuthlevel 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  
  
  ' Set the new queue authentication level in the MSMQQueueInfo object.  
  qinfo.Authenticate = lAuthlevel  
  
  ' Update the internally registered property values.  
  qinfo.Update  
  MsgBox "A new queue authentication level was set."  
  Exit Sub  
  
ErrorHandler:  
  MsgBox "Error " + Hex(Err.Number) + " was returned." _  
          + Chr(13) + Err.Description  
End Sub