2.2.2 Common Data Structures

The following table summarizes the set of common data structures defined by this specification. Common data types are specified in [MS-DTYP].

Unless otherwise specified, multiple-byte fields (16-bit, 32-bit, and 64-bit fields) MUST be transmitted in little-endian order (with the least-significant byte first). Unless otherwise indicated, numeric fields are integers of the specified byte length.

Structure Name

Section

Description

SYNC_GID

[MS-FSVCA] section 2.1

The structure used to represent an identifier for a file that is part of a sync batch.

CLOCK_VECTOR_ELEMENT

[MS-FSVCA] section 2.9

The structure used to represent a version for the file in the sync batch.

SYNC_BLOB

2.2.2.1

The structure used to specify a binary stream of data.

QUOTA_USAGE_ENTRY

2.2.2.2

The structure used to specify the current data usage of a user on the sync target share.

POLICY_ENTRY

2.2.2.3

The structure used to specify the policies on how the client is expected to set up its target directory.

BATCH_LIMITS_ENTRY

2.2.2.4

The structure used to specify the parameters that describe sync batch characteristics.

FILE_METADATA_ENTRY

2.2.2.5

The structure used to specify the metadata information for a file in a sync batch.

FILE_INFO_INPUT_ENTRY

2.2.2.6

The structure used to specify the sync preparation information of a file that the client sends to a server before an upload.

FILE_INFO_ENTRY

2.2.2.7

The structure used to specify the sync preparation information of a file that the server sends to the client before an upload.

FILE_STATUS_ENTRY

2.2.2.8

The structure used to specify the status of a file commit in a sync process.

UPLOAD_ENTRY

2.2.2.9

The structure used to specify information of the data for a file that is being uploaded to the server.

UPLOAD_RESPONSE_ENTRY

2.2.2.10

The structure used to specify the server response data for a file being uploaded.

DOWNLOAD_ENTRY

2.2.2.11

The structure used to specify the information of the data for a file that is being downloaded from the server.

DOWNLOAD_RESPONSE_ENTRY

2.2.2.12

The structure used to specify the server response data for a file being downloaded.

FILE_DOWNLOAD_INFO_ENTRY

2.2.2.13

The structure that specifies the information on how the file content needs to be downloaded by the client.

SYNC_CHANGE_BATCH

2.2.2.14

The structure that defines the metadata describing the changes to be synchronized.

SYNC_MD5HASH

2.2.2.15

The structure that defines the serialization format used by this protocol for MD5 hash data.

VECTOR_POLICY_ENTRY

2.2.2.16

The structure representing a collection of POLICY_ENTRY structures.

VECTOR_FILE_METADATA_ENTRY

2.2.2.17

The structure representing a collection of FILE_METADATA_ENTRY structures.

VECTOR_FILE_INFO_INPUT_ENTRY

2.2.2.18

The structure representing a collection of FILE_INFO_INPUT_ENTRY structures.

VECTOR_FILE_INFO_ENTRY

2.2.2.19

The structure representing a collection of FILE_INFO_ENTRY structures.

VECTOR_FILE_STATUS_ENTRY

2.2.2.20

The structure representing a collection of FILE_STATUS_ENTRY structures.

VECTOR_UPLOAD_ENTRY

2.2.2.21

The structure representing a collection of UPLOAD_ENTRY structures.

VECTOR_UPLOAD_RESPONSE_ENTRY

2.2.2.22

The structure representing a collection of UPLOAD_RESPONSE_ENTRY structures.

VECTOR_DOWNLOAD_ENTRY

2.2.2.23

The structure representing a collection of DOWNLOAD_ENTRY structures.

VECTOR_DOWNLOAD_RESPONSE_ENTRY

2.2.2.24

The structure representing a collection of DOWNLOAD_RESPONSE_ENTRY structures.

VECTOR_FILE_DOWNLOAD_INFO_ENTRY

2.2.2.25

The structure representing a collection of FILE_DOWNLOAD_INFO_ENTRY structures.

VECTOR_STRING

2.2.2.26

The structure representing a collection of ECS_STRING structures.

ECS_STRING

2.2.2.27

The structure representing a UTF-8 string of a prescribed length.