3.1.4.1.6 NspiGetPropList (Opnum 8)

  • Article

The NspiGetPropList method returns a list of all the properties that have values on a specified object.

 long NspiGetPropList(
   [in] NSPI_HANDLE hRpc,
   [in] DWORD dwFlags,
   [in] DWORD dwMId,
   [in] DWORD CodePage,
   [out] PropertyTagArray_r** ppPropTags
 );

hRpc: An RPC context handle, as specified in section 2.2.10.

dwFlags: A DWORD [MS-DTYP] value that contains a set of bit flags. The server MUST ignore values other than the bit flag fSkipObjects.

dwMId: A DWORD value that contains a Minimal Entry ID.

CodePage: The code page in which the client wants the server to express string values properties.

ppPropTags: A PropertyTagArray_r value. On return, it holds a list of properties.

Return Values: The server returns a long value that specifies 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 server returns any return value other than "Success", the server MUST return a NULL for the output parameter ppPropTags.

  2. 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.

  3. If the input parameter dwFlags contains the bit flag fSkipObjects, the server MUST NOT return any proptags with the PtypEmbeddedTable property type in the output parameter ppPropTags.

  4. The server MUST return all string valued properties as having the PtypString8 property type.

  5. Subject to the previous constraints, the server constructs a list of all proptags that correspond to values on the object specified in the input parameter dwMId. The server MUST return this list in the output parameter ppPropTags. The protocol does not constrain the order of this list.

  6. If no error condition has been specified by the previous constraints, the server MUST return the value "Success".