2.2.1.2.129 MPRAPI_OBJECT_HEADER_IDL

The MPRAPI_OBJECT_HEADER_IDL structure SHOULD<116> define the version of the structure that needs to be used by the following methods and structures:

• RRasAdminConnectionEnumEx (section 3.1.4.46) 

• RRasAdminConnectionGetInfoEx (section 3.1.4.47) 

• RAS_CONNECTION_EX_1_IDL (section 2.2.1.2.133) 

• MPR_SERVER_EX_1 (section 2.2.1.2.142) 

• MPR_SERVER_SET_CONFIG_EX_1 (section 2.2.1.2.145) 

• RAS_UPDATE_CONNECTION_1_IDL (section 2.2.1.2.147)

• MPR_SERVER_SET_CONFIG_EX_2 (section 2.2.1.2.241) 

• MPR_SERVER_EX_2 (section 2.2.1.2.242) 

• MPR_IF_CUSTOMINFOEX_0 (section 2.2.1.2.244) 

• MPR_SERVER_SET_CONFIG_EX_3 (section 2.2.1.2.250) 

• MPR_SERVER_EX_3 (section 2.2.1.2.251) 

• MPR_IF_CUSTOMINFOEX_1 (section 2.2.1.2.269) 

   typedef struct _MPRAPI_OBJECT_HEADER_IDL {
     UCHAR revision;
     UCHAR type;
     USHORT size;
   } MPRAPI_OBJECT_HEADER_IDL,
    *PMPRAPI_OBJECT_HEADER_IDL;
  

revision: This represents the version of the structure that is being used depending on the numeric value in the type field. The following values are supported.

Value	Meaning
MPRAPI_RAS_CONNECTION_OBJECT_REVISION_1 0x01	Represents revision 1 of the structure RAS_CONNECTION_EX_1_IDL (section 2.2.1.2.133) if type is 0x01.
MPRAPI_MPR_SERVER_SET_CONFIG_OBJECT_REVISION_1 0x01	Represents revision 1 of the structure MPR_SERVER_SET_CONFIG_EX_1 (section 2.2.1.2.145) if type is 0x03.
MPRAPI_MPR_SERVER_SET_CONFIG_OBJECT_REVISION_2 0x02	Represents revision 2 of the structure MPR_SERVER_SET_CONFIG_EX_2 (section 2.2.1.2.241) if type is 0x03.
MPRAPI_MPR_SERVER_SET_CONFIG_OBJECT_REVISION_3 0x03	Represents revision 3 of the structure MPR_SERVER_SET_CONFIG_EX_3 (section 2.2.1.2.250) if type is 0x03.
MPRAPI_MPR_SERVER_OBJECT_REVISION_1 0x01	Represents revision 1 of the structure MPR_SERVER_EX_1 (section 2.2.1.2.142) if type is 0x02.
MPRAPI_MPR_SERVER_OBJECT_REVISION_2 0x02	Represents revision 2 of the structure MPR_SERVER_EX_2 (section 2.2.1.2.242) if type is 0x02.
MPRAPI_MPR_SERVER_OBJECT_REVISION_3 0x03	Represents revision 3 of the structure MPR_SERVER_EX_3 (section 2.2.1.2.251) if type is 0x02.
MPRAPI_RAS_UPDATE_CONNECTION_OBJECT_REVISION_1 0x01	Represents revision 1 of the structure RAS_UPDATE_CONNECTION_1_IDL (section 2.2.1.2.147) if type is 0x05.
MPRAPI_MPR_IF_CUSTOM_CONFIG_OBJECT_REVISION_1 0x01	Represents revision 1 of the structure MPR_IF_CUSTOMINFOEX_0 (section 2.2.1.2.244) if type is 0x06.
MPRAPI_MPR_IF_CUSTOM_CONFIG_OBJECT_REVISION_2 0x02	Represents revision 2 of the structure MPR_IF_CUSTOMINFOEX_1 (section 2.2.1.2.269) if type is 0x06.

type: The following represents the type of structure being used.

Value	Meaning
MPRAPI_OBJECT_TYPE_RAS_CONNECTION_OBJECT 0x01	Represents a RAS_CONNECTION_EX_IDL (section 2.2.1.2.134) structure.
MPRAPI_OBJECT_TYPE_MPR_SERVER_OBJECT 0x02	Represents an MPR_SERVER_EX structure (MPR_SERVER_EX_1 (section 2.2.1.2.142) structure or an MPR_SERVER_EX_2 (section 2.2.1.2.242)) based on the value of revision.
MPRAPI_OBJECT_TYPE_MPR_SERVER_SET_CONFIG_OBJECT 0x03	Represents an MPR_SERVER_SET_CONFIG_EX structure (an MPR_SERVER_SET_CONFIG_EX_1 or an MPR_SERVER_SET_CONFIG_EX_2 (section 2.2.1.2.241) structure based on the value of revision).
MPRAPI_OBJECT_TYPE_UPDATE_CONNECTION_OBJECT 0x05	Represents a RAS_UPDATE_CONNECTION_1_IDL (section 2.2.1.2.147) structure.
MPRAPI_OBJECT_TYPE_IF_CUSTOM_CONFIG_OBJECT 0x06	Represents an MPR_IF_CUSTOMINFOEX_IDL (section 2.2.1.2.245) structure.

size: Size of the BLOB (structure) being passed based on the type and revision.