Edit

GROUPPROP enumeration (qmgr.h)

  • Article

[Queue Manager (QMGR) is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions. Instead, use the Background Intelligent Transfer Service (BITS).]

The GROUPPROP enumeration defines the constant values for retrieving and setting group property values.

Syntax

typedef enum GROUPPROP {
  GROUPPROP_PRIORITY = 0,
  GROUPPROP_REMOTEUSERID = 1,
  GROUPPROP_REMOTEUSERPWD = 2,
  GROUPPROP_LOCALUSERID = 3,
  GROUPPROP_LOCALUSERPWD = 4,
  GROUPPROP_PROTOCOLFLAGS = 5,
  GROUPPROP_NOTIFYFLAGS = 6,
  GROUPPROP_NOTIFYCLSID = 7,
  GROUPPROP_PROGRESSSIZE = 8,
  GROUPPROP_PROGRESSPERCENT = 9,
  GROUPPROP_PROGRESSTIME = 10,
  GROUPPROP_DISPLAYNAME = 11,
  GROUPPROP_DESCRIPTION = 12
} ;

Constants

 
GROUPPROP_PRIORITY
Value: 0
Determines when the QMGR processes the group relative to other groups in the queue.

There is only one priority. You must specify a value of 1 when setting this property. The property always returns a value of 1.

Variant data type can be VT_I4, VT_I2, VT_UI4, VT_UI2, VT_INT, or VT_UINT.
GROUPPROP_REMOTEUSERID
Value: 1
Not supported.
GROUPPROP_REMOTEUSERPWD
Value: 2
Not supported.
GROUPPROP_LOCALUSERID
Value: 3
Not supported.
GROUPPROP_LOCALUSERPWD
Value: 4
Not supported.
GROUPPROP_PROTOCOLFLAGS
Value: 5
Specifies the protocol to use for the download.

You must specify QM_PROTOCOL_HTTP when setting this property.

Variant data type can be VT_I4, VT_I2, VT_UI4, VT_UI2, VT_INT, or VT_UINT.
GROUPPROP_NOTIFYFLAGS
Value: 6
Specifies the type of event notification to receive for the group. See Remarks.

Variant data type can be VT_I4, VT_I2, VT_UI4, VT_UI2, VT_INT, or VT_UINT.
GROUPPROP_NOTIFYCLSID
Value: 7
The CLSID to activate when an event specified by GROUPPROP_NOTIFYFLAGS occurs. For more details on CLSID activation, see IBackgroundCopyCallback1.

Variant data type is VT_BSTR.
GROUPPROP_PROGRESSSIZE
Value: 8
Not supported.
GROUPPROP_PROGRESSPERCENT
Value: 9
Not supported.
GROUPPROP_PROGRESSTIME
Value: 10
Not supported.
GROUPPROP_DISPLAYNAME
Value: 11
Specifies a display name that can be used to identify the group in a user interface. The length of the string is limited to 256 characters, not including the null terminator.

Variant data type is VT_BSTR.
GROUPPROP_DESCRIPTION
Value: 12
Specifies a description to associate with the group. The length of the string is limited to 1,024 characters, not including the null terminator.

Variant data type is VT_BSTR.

Remarks

The GROUPPROP_NOTIFYFLAGS group property can contain one or more of the following notification flags.

Flag Meaning
QM_NOTIFY_FILE_DONE Not supported.
QM_NOTIFY_JOB_DONE Not supported.
QM_NOTIFY_GROUP_DONE Notifies the application through IBackgroundCopyCallback1::OnStatus that the group is complete.
QM_NOTIFY_DISABLE_NOTIFY Disables all notifications.
QM_NOTIFY_USE_PROGRESSEX Not supported.
 
Note  By default, QMGR calls your IBackgroundCopyCallback1::OnStatus method when an error occurs.
 

Requirements

Requirement Value
Minimum supported client Windows XP
Minimum supported server Windows Server 2003
Header qmgr.h