Share via

3.1.4.22.5 QueryConglomerationPassword (Opnum 7)

  • Article

This method is called by a replication client application to obtain the value of the Password property of a conglomeration.

 HRESULT QueryConglomerationPassword(
   [in] REFGUID ConglomerationId,
   [out, size_is(, *pcbPassword)] char** ppvPassword,
   [out] ULONG* pcbPassword
 );

ConglomerationId: The conglomeration identifier of the conglomeration whose Password property is requested.

ppvPassword: A pointer to a variable that, upon successful completion, MUST be set to an array of bytes containing a null-terminated array of wchar_t in little-endian byte order.

pcbPassword: A pointer to a variable that, upon successful completion, MUST be set to the length of ppvPassword.

Return Values: This method MUST return S_OK (0x00000000) on success, and a failure result, as specified in [MS-ERREF] section 2.1, on failure. All failure results MUST be treated identically.

Upon receiving a call to this method, the server SHOULD<354> verify that there exists a conglomeration with the conglomeration identifier specified in ConglomerationId, and fail the call if not.

The server then MUST attempt to retrieve the value of the conglomeration's Password property, possibly by accessing an encrypted secret store, and fail the call if it cannot.

The server then MUST set ppvPassword to this value and return success.