2.2.5.5.1 GetMatches Request Type Request Body

The GetMatches request type request body contains the following fields.

Reserved (4 bytes): Reserved. The client MUST set this field to 0x00000000 and the server MUST ignore this field.

HasState (1 byte): A Boolean value that specifies whether the State field is present.

State (optional) (36 bytes): A STAT structure ([MS-OXNSPI] section 2.2.8) that specifies the state of a specific address book container. This field is present when the value of the HasState field is nonzero and is not present otherwise.

HasMinimalIds (1 byte): A Boolean value that specifies whether the MinimalIdCount and MinimalIds fields are present.

MinimalIdCount (optional) (4 bytes): An unsigned integer that specifies the number of structures present in the MinimalIds field. This field is present when the value of the HasMinimalIds field is nonzero and is not present otherwise.

MinimalIds (optional) (variable): An array of MinimalEntryID structures ([MS-OXNSPI] section 2.2.9.1) that constitute an Explicit Table. For details about Explicit Tables, see [MS-OXNSPI] section 3.1.4.4.2. This field is present when the value of the HasMinimalIds field is nonzero and is not present otherwise.

InterfaceOptionFlags (4 bytes): Reserved. The client MUST set this field to 0x00000000 and the server MUST ignore this field.

HasFilter (1 byte): A Boolean value that specifies whether the Filter field is present.

Filter (optional) (variable): A restriction, as specified in [MS-OXCDATA] section 2.12, that is to be applied to the rows in the address book container. This field is present when the value of HasFilter is nonzero and is not present otherwise.

HasPropertyName (1 byte): A Boolean value that specifies whether the PropertyNameGuid and PropertyNameId fields are present.

PropertyNameGuid (optional) (16 bytes): The GUID of the property to be opened. This field is present when the value of the HasPropertyName field is nonzero and is not present otherwise.

PropertyNameId (optional) (4 bytes): A 4-byte value that specifies the ID of the property to be opened. This field is present when the value of the HasPropertyName field is nonzero and is not present otherwise.

RowCount (4 bytes): An unsigned integer that specifies the number of rows the client is requesting.

HasColumns (1 byte): A Boolean value that specifies whether the Columns field is present.

Columns (optional) (variable): A LargePropertyTagArray structure (section 2.2.1.8) that specifies the columns that the client is requesting. This field is present when the value of the HasColumns field is nonzero and is not present otherwise.

AuxiliaryBufferSize (4 bytes): An unsigned integer that specifies the size, in bytes, of the AuxiliaryBuffer field.

AuxiliaryBuffer (variable): An array of bytes that constitute the auxiliary payload data sent from the client. The size of this field, in bytes, is specified by the AuxiliaryBufferSize field. For details about extended buffers and auxiliary payloads, see [MS-OXCRPC] section 3.1.4.2.1 and section 3.1.4.2.2.