[MS-DFSRH]: DFS Replication Helper Protocol Specification

3.1.5.4.6 GetReferenceBacklogCount Method (Opnum 8)The GetReferenceBacklogCount method gets the outbound backlog for a replicated folder on themember, relative to specific version vectors.HRESULT GetReferenceBacklogCounts([in] SAFEARRAY(_VersionVectorData)* flatMemberVersionVectors,[out] SAFEARRAY(long)* backlogCounts);flatMemberVersionVectors: MUST be the version vector of the replication group on anothermember that is participating in the same replication group. If multiple members are specifiedin the flatMemberVersionVectors array, the backlogCounts array contains the backlog countsfor each reference vector specified.backlogCounts: The relative backlog for each reference vector in flatMemberVersionVectorsMUST be returned in this output parameter. The length of the backlogCounts array MUST bethe same as the length of flatMemberVersionVectors. The value on each position in thereturned array MUST correspond to the version vector on the same position in theflatMemberVersionVectors array.Return Values: The method MUST return 0 on success or return an implementation-specificnonzero HRESULT error code, as specified in [MS-ERREF] section 2.1, between 0x80000000and 0xFFFFFFFF on failure. For protocol purposes, all nonzero values MUST be treated asequivalent failures.After the server receives this message, it MUST get the backlog count for each version vector that issupplied in the message parameters. If the server fails to retrieve a backlog count, it returns aspecial value in the backlogCounts array at an index that corresponds to the index in theflatMemberVersionVectors for the entry that was used as input. The overall method MAY still returnsuccess (S_OK). These special values are as follows:• BACKLOG_CONTENT_SET_NOT_PRESENT (0xffffffff): The content set is not present in DFS-R.• BACKLOG_ERROR_VECTOR_DECOMPRESS_FAILED (0xfffffffe): The flat member version vectorcould not be decompressed by using Xpress.• BACKLOG_ERROR_EMPTY_VECTOR_FROM_MEMBER (0xfffffffe): The version vector is empty,that is, it has a 0 length.• BACKLOG_ERROR_GET_BACKLOG_FAILED (0xfffffffe): Other run-time errors or implementationspecificerrors that prevent the calculation of the backlog count.The backlog counts MUST be saved in the backlogCounts output parameter.The server MUST return the response to the client. The response MUST contain the outputparameters that were previously mentioned and also the status of the operation.3.1.6 Timer EventsNo timer events are used in the DFS-R Helper Protocol.3.1.7 Other Local EventsNo other local events are used in the DFS-R Helper Protocol.[MS-DFSRH] – v20080207DFS Replication Helper Protocol SpecificationCopyright © 2008 Microsoft Corporation.Release: Thursday, February 7, 200866 / 81