3.1.4.11 NspiResortRestriction (Opnum 6)

  • Article

The NspiResortRestriction method applies a sort order to the objects in a restricted address book container.

 long NspiResortRestriction(
   [in] NSPI_HANDLE hRpc,
   [in] DWORD Reserved,
   [in, out] STAT* pStat,
   [in] PropertyTagArray_r* pInMIds,
   [in, out] PropertyTagArray_r** ppOutMIds
 );

hRpc: An RPC context handle as specified in section 2.3.9.

Reserved: A DWORD value reserved for future use. Ignored by the server.

pStat: A reference to a STAT block describing a logical position in a specific address book container.

pInMIds: A PropertyTagArray_r value. It holds a list of MIds that comprise a restricted address book container.

ppOutMIds: A PropertyTagArray_r value. On return, it holds a list of MIds that comprise a restricted address book container.

Return Values: The server returns a long value specifying the return status of the method.

Exceptions Thrown

No exceptions are thrown beyond those thrown by the underlying RPC protocol, as specified in [MS-RPCE].

Server Processing Rules

Upon receiving this message, the server MUST process the data from the message subject to the following constraints:

  1. If the CodePage field of the input parameter pStat contains the value CP_WINUNICODE, the server MUST return one of the return values documented in section 2.2.2.  No further constraints are applied to server processing of this method; in this case server behavior is undefined.  Note especially that there is no constraint on the data the server returns in any output parameter other than the return value, nor is there any constraint on how or if the server changes its state.

  2. If the SortType field of the input parameter pStat contains any value other than SortTypeDisplayName or SortTypePhoneticDisplayName, the server MUST return one of the return values documented in section 2.2.2.  No further constraints are applied to server processing of this method; in this case server behavior is undefined.  Note especially that there is no constraint on the data the server returns in any output parameter other than the return value, nor is there any constraint on how or if the server changes its state.

  3. If the server returns any return values other than Success, the server MUST return a NULL for the output parameter ppOutMIds and MUST NOT modify the value of the parameter pStat

  4. The server MAY make additional validations as described in section 5. If the server chooses to limit the visibility of data based on these validations, the server MUST proceed as if that data did not exist in the address book. See the product behavior note cited in section 5.1 for more information.

  5. If the server does not support the SortTypePhoneticDisplayName and the SortType field of the input parameter pStat has the value SortTypePhoneticDisplayName, the server MUST return the value GeneralFailure.

  6. The server constructs an Explicit Table as follows:

    1. The server locates all the objects specified in the Explicit Table specified by the input value pInMIds. The server MUST ignore any MIds that do not specify an object.

    2. For each such object located, a row is inserted into the constructed Explicit Table.

    3. The server MUST sort the rows in the constructed explicit table by the property specified in the SortType field of the input parameter pStat.

  7. The server MUST return the constructed Explicit Table in the output parameter ppOutMIds.

  8. The server MUST update the output parameter pStat as follows:

    1. The TotalRecs field is set to the number of objects in the constructed Explicit Table.

    2. If the object specified by the CurrentRec field of the input parameter pStat is not in the constructed Explicit Table, the CurrentRec field of the output parameter pStat is set to the value MID_BEGINNING_OF_TABLE and the NumPos field of the output parameter pStat is set to the value 0.

    3. If the object specified by the CurrentRec field of the input parameter pStat is in the constructed Explicit Table, the NumPos field of the output parameter pStat is set to the numeric position in the Explicit Table.

    4. The server MUST NOT modify any other fields of the output parameter pStat.

  9. If no other return values have been specified by these constraints, the server MUST return the return value Success.