Cet article a fait l’objet d’une traduction automatique. Pour afficher l’article en anglais, activez la case d’option Anglais. Vous pouvez également afficher le texte anglais dans une fenêtre contextuelle en faisant glisser le pointeur de la souris sur le texte traduit.
Traduction
Anglais

Utilisation de CSISyncClient pour contrôler le Cache de documents Office (ODC)

Office 2013 et versions ultérieures

Découvrez comment utiliser CSISyncClient pour contrôler le Cache de documents (ODC) Office.

Dernière modification :lundi 13 juillet 2015

CSISyncClient est un serveur COM out-of-process (CsiSyncClient.exe) qui permet à Microsoft OneDrive contrôler le comportement de la Office du Cache de documents (ODC). Par exemple, OneDrive peuvent faire appel à la ODC via CSISyncClient à télécharger des fichiers vers et à partir de points de terminaison MS-FSSHTTP est activé. Cela permet à des fonctionnalités avancées reposant sur le service de Office, tels que les transitions de co-création et transparentes d'en mode hors connexion à en ligne.

CsiSyncClient est disponible dans Office bureau (x 86 et x 64). Remarque : Lorsque de nouvelles versions de Office peuvent livrées avec CsiSyncClient, le processus sont utilisé pour la compatibilité descendante uniquement. L'interface CsiSyncClient et la méthodologie de contrôler le ODC seront modifié dans les futures versions de Office.

L'ID de classe est actuellement défini pour répondre uniquement à OneDrive.

L'objet COM est utilisable comme serveur COM out-of-proc et s'exécute dans CsiSyncClient.exe. En raison de limitations avec Access (qui repose sur le ODC), elle fourni avec le type de transmission que Office intervient, c'est le cas x 64 Office signifie que l'objet COM x 64 ou x 86 Office signifie qu'un objet de COM x 86. Pour contourner cette limitation, spécification CLSCTX_LOCAL_SERVER comme partie de l'interface CoCreateInstance aura l'objet COM être hébergé en tant qu'un serveur COM out-of-process, autoriser la compatibilité cross-nombre de bits.

CSISyncClient utilise les interfaces suivantes.

Interface ILSCLocalSyncClient

Il s'agit de l'interface principale utilisée pour synchroniser des fichiers dans Office.

ProgID: Office.LocalSyncClient

CLSID: {14286318-B6CF-49a1-81FC-D74AD94902F9}

Bibliothèque de types: {66CDD37F-D313-4e81-8C31-4198F3E42C3C}

L'objet COM qui est exposé est utilisé comme un serveur out-of-Process. Spécification CLSCTX_LOCAL_SERVER dans le cadre de CoCreateInstance permet la compatibilité entre les processus 32 bits et 64 bits.

Une fois que vous avez co-créé de l'objet COM, vous devez d'abord appeler ILSCLocalSyncClient::Initialize . Une fois que ILSCLocalSyncClient::Initialize a réussi, vous pouvez appeler n'importe quelle API autant de fois que vous le souhaitez et dans n'importe quel ordre. Vous pouvez également appeler ILSCLocalSyncClient::Initialize sur un objet déjà initialisé, mais cela n'a aucun effet.

Les exceptions pour le paragraphe précédent sont ILSCLocalSyncClient::ResetCache et ILSCLocalSyncClient::Uninitialize. Une fois que vous appelez ILSCLocalSyncClient::Uninitialize sur l'objet COM, vous devez détruire cet objet et créer un nouveau. ILSCLocalSyncClient::ResetCache supprimer votre subcache, supprimez toutes les informations de fichier associé dans le cache, mais laissez les documents sur le disque. Elle aussi conserve l'état pour communiquer avec le cache. Cela vous permet d'appeler ILSCLocalSyncClient::Initialize à nouveau pour créer un nouveau cache sans avoir à détruire et recréer l'objet COM.

Fonctions membres publics

ILSCLocalSyncClient::DeleteFile

DeleteFile est utilisée pour supprimer les informations du fichier à partir du cache. Toutefois, cette méthode laisse le fichier associé sur le disque et sur le serveur.

HRESULT ILSCLocalSyncClient::DeleteFile ( [in] BSTR bstrResourceID )

Paramètres

bstrResourceID

Chaîne qui identifie le ResourceID du fichier. Cette valeur doit être non vides avec un maximum de 128 caractères.

Valeurs renvoyées

Valeur

Description

E_FAIL

L’appel n’a pas réussi.

E_INVALIDARG

Un ou plusieurs paramètres ne sont pas valides.

E_FAIL

L’appel n’a pas réussi.

E_LSC_FILENOTFOUND

Le ResourceID donné n'est pas dans le cache.

E_LSC_NOTINITIALIZED

Initialize n'a pas été correctement appelé dans le passé.

E_LSC_PENDINGCHANGESINCACHE

Le fichier est en cours de synchronisation ou ouvrir et ne peut pas être supprimée.

S_OK

L’appel a réussi.

ILSCLocalSyncClient::GetChanges

GetChanges retourne un énumérateur des objets de ILSCEvent et retourne également un jeton qui est donné à l'appel suivant à GetChanges, en supposant que le consommateur a traité l'ensemble précédent d'événements. Événements avant le nPreviousChangesToken spécifié sera supprimé et indisponible. S'il n'y a aucun événement à traiter, pnCurrentChangesToken doit être la même valeur que nPreviousChangesToken, mais aura toujours la valeur ppiEvents .

HRESULT ILSCLocalSyncClient::GetChanges ( [in] LONG nPreviousChangesToken, [out] LONG * pnCurrentChangesToken, [out] IEnumLSCEvent ** ppiEvents )

Paramètres

nPreviousChangesToken

Identifie l'événement qui a été traitée en dernier par le consommateur.

pnCurrentChangesToken

Identifie l'événement le plus récent est transmise au consommateur. Ne doit pas être null.

ppiEvents

Énumérateur pour les événements remis au consommateur. Ne doit pas être null.

Valeurs renvoyées

Valeur

Description

E_FAIL

L’appel n’a pas réussi.

E_INVALIDARG

Un ou plusieurs paramètres ne sont pas valides.

E_LSC_NOTINITIALIZED

ILSCLocalSyncClient::Initialize n'a pas été correctement appelé dans le passé.

S_OK

L’appel a réussi.

ILSCLocalSyncClient::GetClientNetworkSyncPermission

GetClientNetworkSyncPermission est utilisée pour interroger si heuristiques de Office de synchronisation pour les coûts de réseau et la consommation d'énergie sont remplacées. Lorsque dans un 3G ou un autre réseau coûteuses, ou lors de l'exécution sur la batterie par rapport à branché, Office peut choisir de bloquer le trafic réseau jusqu'à un moment plus opportun.

HRESULT ILSCLocalSyncClient::GetClientNetworkSyncPermission ( [in] LSCNetworkSyncPermissionType nspType, [out] VARIANT_BOOL * pfSyncEnabled )

Paramètres

nspType

Indicateur qui définit le heuristique revient à interroger. Voir Enum LSCNetworkSyncPermissionType.

pfSyncEnabled

Spécifie si l'heuristique coût demandé est actuellement substituée ou ne pas. Ne doit pas être null.

Valeurs renvoyées

Valeur

Description

E_FAIL

L’appel n’a pas réussi.

E_INVALIDARG

Un ou plusieurs paramètres ne sont pas valides.

E_LSC_NOTINITIALIZED

ILSCLocalSyncClient::Initialize n'a pas été correctement appelé dans le passé.

S_OK

L’appel a réussi.

ILSCLocalSyncClient::GetFileStatus

GetFileStatus est utilisé pour collecter des informations pour un fichier spécifique : si elle existe dans le cache, si elle est en attente de la communication avec la copie sur le serveur, et si Office 2013 possède le plus à des données de date à partir de la copie locale. Il nécessite un indicateur de bits des valeurs Enum LSCStatusFlag afin de déterminer quelles informations l'objet CsiSyncClient COM consiste à interroger.

HRESULT ILSCLocalSyncClient::GetFileStatus ( [in] BSTR bstrResourceID, [in] LSCStatusFlag sfRequestedStatus, [out] BSTR * pbstrFileSystemPath, [out] BSTR * pbstrETag, [out] LSCStatusFlag * psfFileStatus )

Paramètres

bstrResourceID

Chaîne qui identifie le fichier sur le client. Cette valeur doit être vide, avec un maximum de 128 caractères.

sfRequestedStatus

Indicateur qui définit les informations à renvoyer. Voir Enum LSCStatusFlag.

pbstrFileSystemPath

Chaîne qui identifie l'emplacement du fichier identifié par bstrResourceID sur le client. Ne doit pas être null.

pbstrETag

Chaîne qui contient l'eTag pour le fichier identifié par bstrResourceID. Ne doit pas être null.

psfFileStatus

Indicateur qui contiendra le statut demandé par le biais de sfRequestedStatus pour le fichier identifié par bstrResourceID. Ne doit pas être null. Voir Enum LSCStatusFlag.

Valeurs renvoyées

Valeur

Description

E_FAIL

L’appel n’a pas réussi.

E_INVALIDARG

Un ou plusieurs paramètres ne sont pas valides.

E_LSC_FILENOTFOUND

Les informations du fichier spécifiées par bstrResourceID n'existent pas dans le cache.

E_LSC_LOCALFILEUNAVAILABLE

LSCStatusFlag_LocalFileUnchanged a été demandé, ou le fichier spécifié par bstrResourceID est verrouillé ou manquant.

E_LSC_NOTINITIALIZED

ILSCLocalSyncClient::Initialize n'a pas été correctement appelé dans le passé.

S_OK

L’appel a réussi.

ILSCLocalSyncClient::GetSupportedFileExtensions

GetSupportedFileExtensions renvoie une liste délimitée par des canaux d'extensions de fichiers qui sont actuellement pris en charge par l'objet COM de CsiSyncClient. Notez que cette liste peut modifier, et le consommateur serez ainsi averti d'une modification par le biais de l'objet IPartnerActivityCallback fourni sur ILSCLocalSyncClient::Initialize (voir EventOccured).

Un exemple de la chaîne renvoyée se présente comme suit: « |docx|docm|pptx| »

HRESULT ILSCLocalSyncClient::GetSupportedFileExtensions ( [out] BSTR * pbstrSupportedFileExtensions )

Paramètres

pbstrSupportedFileExtensions

Chaîne à définir avec un ensemble délimité par canal d'extensions de fichier pris en charge par l'objet COM de CsiSyncClient. Ne doit pas être null.

Valeurs renvoyées

Valeur

Description

E_FAIL

L’appel n’a pas réussi.

E_INVALIDARG

Un ou plusieurs paramètres ne sont pas valides.

E_LSC_NOTINITIALIZED

ILSCLocalSyncClient::Initialize n'a pas été correctement appelé dans le passé.

S_OK

L’appel a réussi.

ILSCLocalSyncClient::Initialize

Initialize doit être la première méthode appelée. Dans le cas contraire, tous les autres API renverra E_LSC_NOTINITIALIZED. L'appel de Initialize sur un objet déjà initialisé renvoie S_OK et n'a aucun effet. Si E_LSC_CACHEMISMATCH est renvoyée, l'appelant peut appeler ILSCLocalSyncClient::ResetCache pour supprimer le cache associé à le SuppliedID donné. Toutefois, dans ce cas autres API retournera encore E_LSC_NOTINITIALIZED.

HRESULT ILSCLocalSyncClient::Initialize ( [in] BSTR bstrSuppliedID, [in] BSTR bstrProgID, [in] BSTR bstrFileSystemDirectoryHint, [in] IPartnerActivityCallback * pEventCallback, [out] VARIANT_BOOL * pfCreatedNewCache )

Paramètres

bstrSuppliedID

Identifie le consommateur et qui mettent en cache à utiliser. Doit être non vides avec un maximum de 32 caractères.

bstrProgID

Identifie l'objet de COM du consommateur pour la communication bidirectionnelle. Doit être non vides avec un maximum de 39 caractères. Voir <ProgID> Key pour plus d'informations sur les ProgIDs.

bstrFileSystemDirectoryHint

Identifie la racine du répertoire dans lequel seront stockés les fichiers locaux. Doit être non vides avec un maximum de 256 caractères. Le répertoire doit déjà exister.

pEventCallback

L'interface de rappel qui CsiSyncClient vous avertit des modifications apportées. Voir IPartnerActivityCallback::EventOccurred. Cette valeur ne doit pas être nulle.

pfCreatedNewCache

Renvoie si un nouveau cache a été créé. Si aucun cache n'est associé à le SuppliedID, un sera créé. Cette valeur ne doit pas être nulle.

Valeurs renvoyées

Valeur

Description

E_FAIL

L’appel n’a pas réussi.

E_INVALIDARG

Un ou plusieurs paramètres ne sont pas valides.

E_LSC_CACHEMISMATCH

Un SuppliedID déjà possède un cache qui lui est associé, mais dispose d'un ProgId ou FileSystemDirectoryHint différentes de celles qui sont fournies.

E_LSC_DIRECTORYHINTCONFLICT

Le FileSystemDirectoryHint (ou un sous-dossier) existe déjà sur un cache différent.

E_LAC_PROGIDCONFLICT

Le ProgID existe déjà sur un cache différent.

S_OK

L’appel a réussi.

ILSCLocalSyncClient::LocalFileChange

LocalFileChange sert à indiquer à l'objet COM de CsiSyncClient pour essayer de charger le fichier spécifié. La méthode préparera le fichier de téléchargement, y compris le contenu du fichier en cours de lecture. Si un téléchargement est déjà en attente, téléchargement précédent sera ignoré et le nouveau contenu préparé pour télécharger. Si le fichier est ouvert pour modification dans une application , cette méthode renvoie S_OK sans préparer le fichier de téléchargement (l'application doit déjà effectuer cette étape si des modifications sont apportées).

Cette méthode permettra volumineux s'il a été marqué comme télécharge bloqués précédemment (voir ILSCLocalSyncClient::RenameFile).

HRESULT ILSCLocalSyncClient::LocalFileChange ( [in] BSTR bstrFileSystemPath, [in] BSTR bstrWebPath, [in] BSTR bstrResourceID )

Paramètres

bstrFileSystemPath

Une chaîne qui identifie le fichier sur le client. Cette valeur doit être un chemin d'accès local non vide avec un maximum de 256 caractères. Ce chemin d'accès doit être dans l'arborescence du répertoire spécifié par le FileSystemDirectoryHint lors de l'appel à ILSCLocalSyncClient::Initialize a été effectué.

bstrResourceID

Une chaîne qui identifie le ResourceID du fichier. Cette valeur doit être non vides avec un maximum de 128 caractères.

bstrWebPath

Une chaîne qui identifie le fichier sur le serveur. Cette valeur doit être URL non vides, valide, mais pas plus de INTERNET_MAX_URL_LENGTH, tel que défini par http://support.microsoft.com/kb/208427.

Valeurs renvoyées

Valeur

Description

E_FAIL

L’appel n’a pas réussi.

E_INVALIDARG

Un ou plusieurs paramètres ne sont pas valides.

E_LSC_CONFLICTINGFILE

Le fichier spécifié par bstrFileSystemPath a un ResourceID autre que ceux spécifiés. Un événement de type LSCEventType_OnFilePathConflict est envoyée lorsque cette erreur est renvoyée. Voir ILSCLocalSyncClient::GetChanges.

E_LSC_FILENOTFOUND

Le fichier a été supprimée opération intermédiaire.

E_LSC_FILENOTSUPPORTED

L'extension de fichier donné n'est pas pris en charge par l'objet COM de CsiSyncClient. Voir ILSCLocalSyncClient::GetSupportedFileExtensions.

E_LSC_FILEUPTODATE

L'objet COM n'avez pas prévu un téléchargement, car le fichier dans le cache comportait des modifications les plus récentes à partir du disque.

E_LSC_LOCALFILEUNAVAILABLE

Le fichier spécifié par bstrFileSystemPath est manquant ou verrouillé.

E_LSC_LOCALPATHNOTMAPPED

Le FileSystemPath donné n'est pas sous la racine du répertoire spécifiée par le FileSystemDirectoryHint lors de l'appel de Initialize a été établie.

E_LSC_NOTINITIALIZED

ILSCLocalSyncClient::Initialize n'a pas été correctement appelé dans le passé.

E_LSC_PATHMISMATCH

Le fichier spécifié par bstrResourceID a une FileSystemPath autre que ceux spécifiés.

E_LSC_PENDINGCHANGESINCACHE

Le fichier spécifié déjà en attente de modification dans un cache différent et ne peut pas être encore associé du cache du consommateur.

E_LSC_SERVERPATHINDIFFERENTCACHE

Le WebPath fourni se situe sous un cache différent.

S_OK

L’appel a réussi.

ILSCLocalSyncClient::RenameFile

RenameFile associe une nouvelle URL et le chemin d'accès local pour un ResourceID donné. Si le fichier spécifié par le ResourceID n'existe pas déjà dans le cache, une tentative sera effectuée pour le créer et marquer pour téléchargement.

HRESULT ILSCLocalSyncClient::RenameFile ( [in] BSTR bstrResourceID, [in] BSTR bstrNewFileSystemPath, [in] BSTR bstrNewWebPath, [in] VARIANT_BOOL fBlockUploads )

Paramètres

bstrResourceID

Une chaîne qui identifie le ResourceID du fichier. Cette valeur doit être non vides avec un maximum de 128 caractères.

bstrNewFileSystemPath

Chaîne qui spécifie le nouveau chemin d'accès local pour le fichier. Cette valeur doit être un chemin d'accès local non vide avec un maximum de 256 caractères. Ce chemin d'accès doit être dans l'arborescence du répertoire spécifié par le FileSystemDirectoryHint lors de l'appel d'initialisation a été effectuée.

bstrNewWebPath

Chaîne qui spécifie la nouvelle URL pour le fichier. Cette valeur doit être non vides URL valide, mais pas plus de INTERNET_MAX_URL_LENGTH, tel que défini par http://support.microsoft.com/kb/208427.

fBlockUploads

Spécifie si les téléchargements vers le nouvel emplacement sont actuellement autorisées.

Valeurs renvoyées

Valeur

Description

E_FAIL

L’appel n’a pas réussi.

E_INVALIDARG

Un ou plusieurs paramètres ne sont pas valides.

E_LSC_CONFLICTINGFILE

Le bstrNewFileSystemPath ou bstrNewWebPath existent déjà sur un autre fichier dans n'importe quel cache. Un événement de type LSCEventType_OnFilePathConflict est envoyée lorsque cette erreur est renvoyée. Voir ILSCLocalSyncClient::GetChanges.

E_LSC_FILENOTFOUND

Les informations du fichier a été supprimées du cache pendant l'exécution de cette méthode.

E_LSC_LOCALPATHNOTMAPPED

Le FileSystemPath donné n'est pas sous la racine du répertoire spécifiée par le FileSystemDirectoryHint lors de l'appel de Initialize a été établie.

E_LSC_NOTINITIALIZED

ILSCLocalSyncClient::Initialize n'a pas été correctement appelé dans le passé.

E_LSC_PENDINGCHANGESINCACHE

Le fichier spécifié est en cours de synchronisation dans une application Office.

S_OK

L’appel a réussi.

ILSCLocalSyncClient::ResetCache

ResetCache supprime le cache associé à le SuppliedID qui a été fourni dans Initialize. Cela inclut toutes les informations sur les fichier, mais laisse les fichiers sur le client et le serveur. Cette méthode rend également l'objet dans un état partiellement non initialisé. Les appels valides uniquement après ce sont ILSCLocalSyncClient::Initialize ou ILSCLocalSyncClient::Uninitialize. Cette méthode peut être appelée si Initialize échoue et renvoie E_LSC_CACHEMISMATCH et supprime le cache associé à le SuppliedID qui a été fournie avec l'appel défectueux.

HRESULT ILSCLocalSyncClient::ResetCache( )

Paramètres

Aucune

Valeurs renvoyées

Valeur

Description

E_FAIL

L’appel n’a pas réussi.

E_LSC_NOTINITIALIZED

ILSCLocalSyncClient::Initialize n'a pas été appelée avec succès dans le passé.

S_OK

L’appel a réussi.

ILSCLocalSyncClient::ServerFileChange

ServerFileChange indique à l'objet COM de CsiSyncClient pour marquer le fichier spécifié pour le téléchargement. Si le fichier est ouvert dans une application Office pour le modifier, cette méthode renvoie S_OK sans marquage du fichier de téléchargement (l'application doit déjà effectuer cette étape si des modifications sont apportées).

Cette méthode permettra de téléchargements s'il a été marqué comme téléchargements bloqués précédemment (voir RenameFile).

HRESULT ILSCLocalSyncClient::ServerFileChange ( [in] BSTR bstrFileSystemPath, [in] BSTR bstrWebPath, [in] BSTR bstrResourceID )

Paramètres

Paramètre

Description

bstrFileSystemPath

Une chaîne qui identifie le fichier sur le client. Cette valeur doit être un chemin d'accès local non vide avec un maximum de 256 caractères. Ce chemin d'accès doit être dans l'arborescence du répertoire spécifié par le FileSystemDirectoryHint lors de l'appel d'initialisation a été effectuée.

bstrResourceID

Une chaîne qui identifie le ResourceID du fichier. Cette valeur doit être non vides avec un maximum de 128 caractères.

bstrWebPath

Une chaîne qui identifie le fichier sur le serveur. Cette valeur doit être une URL valide non vide, mais pas plus de INTERNET_MAX_URL_LENGTH, tel que défini par http://support.microsoft.com/kb/208427.

Valeurs renvoyées

Valeur

Description

E_FAIL

Échec pour définir l'état de la connectivité du cache.

E_LSC_CONFLICTINGFILE

Le fichier spécifié par bstrFileSystemPath a un ResourceID autre que ceux spécifiés.

E_LSC_FILENOTSUPPORTED

L'extension de fichier donné n'est pas pris en charge par l'objet COM de CsiSyncClient. Voir GetSupportedFileExtensions.

E_LSC_FILENOTFOUND

Le fichier a été supprimé lors d'une opération intermédiaire.

E_INVALIDARG

Un ou plusieurs paramètres ne sont pas valides.

E_LSC_LOCALPATHNOTMAPPED

Le FileSystemPath donné n'est pas sous la racine du répertoire spécifiée par le FileSystemDirectoryHint lors de l'appel de Initialize a été établie.

E_LSC_NOINITIALIZED

ILSCLocalSyncClient::Initialize n'a pas été correctement appelé dans le passé.

E_LSC_PATHMISMATCH

Le fichier spécifié par bstrResourceID a une FileSystemPath autre que ceux spécifiés.

E_LSC_PENDINGCHANGESINCACHE

Le fichier spécifié comporte des modifications en attente dans un cache différent déjà et ne peut pas être encore associé du cache du consommateur.

E_LSC_SERVERPATHINDIFFERENTCACHE

Le WebPath fourni se situe sous un cache différent.

S_OK

L’appel a réussi.

ILSCLocalSyncClient::SetClientConnectivityState

Définit le cache dans un état en ligne ou hors connexion. Si elle est en mode hors connexion, Office ne tentera pas de communiquer avec le serveur pour tous les fichiers dans ce cache, quel que soit le paramètre de fBlockUploads de chaque fichier individuel.

HRESULT ILSCLocalSyncClient::SetClientConnectivityState ( [in] VARIANT_BOOL fIsOnline )

Paramètres

fIsOnline

Valeur booléenne détermination de l'état de la connectivité du cache.

Valeurs renvoyées

Valeur

Description

E_FAIL

Échec pour définir l'état de la connectivité du cache.

E_INVALIDARG

Un ou plusieurs paramètres ne sont pas valides.

E_LSC_NOINITIALIZED

ILSCLocalSyncClient::Initialize n'a pas été correctement appelé dans le passé.

S_OK

L’appel a réussi.

ILSCLocalSyncClient::SetClientNetworkSyncPermission

SetClientNetworkSyncPermission est utilisée pour remplacer ou restaurer heuristiques de synchronisationOffice du coût du réseau et la consommation d'énergie. Lorsque dans un 3G ou un autre réseau coûteuses, ou lors de l'exécution sur la batterie par rapport à branché, Office peut choisir de bloquer le trafic réseau jusqu'à un moment plus opportun. Le consommateur de cette API permet elle substituer Office d'heuristiques et forcer la synchronisation doit avoir lieu.

HRESULT ILSCLocalSyncClient::SetClientNetworkSyncPermission ( [in] LSCNetworkSyncPermissionType nspType, [in] VARIANT_BOOL fEnableSync )

Paramètres

nspType

Indicateur qui définit le heuristique revient à remplacer. Voir Enum LSCNetworkSyncPermissionType.

fEnableSync

Spécifie s'il faut forcer la synchronisation, remplaçant ainsi que heuristique de coût, ou n'est plus la remplacer.

Valeurs renvoyées

Valeur

Description

E_FAIL

Échec de remplacer heuristiques de synchronisation.

E_LSC_NOINITIALIZED

ILSCLocalSyncClient::Initialize n'a pas été correctement appelé dans le passé.

S_OK

L’appel a réussi.

ILSCLocalSyncClient::Uninitialize

Décharge le cache de l'objet COM et effectuer des opérations de fermeture. ILSCLocalSyncClient::Uninitialize DOIT être appelée avant la destruction de l'objet COM. Une fois appelée, aucune autre API ne peut être appelé, l'objet COM doit être détruit et créer une nouvelle si vous souhaitez poursuivre les opérations.

HRESULT ILSCLocalSyncClient::Uninitialize ( )

Paramètres

Aucun

Valeurs renvoyées

Valeur

Description

E_FAIL

Échec d'annuler l'initialisation.

E_LSC_NOINITIALIZED

ILSCLocalSyncClient::Initialize n'a pas été correctement appelé dans le passé.

S_OK

L’appel a réussi.

Interface IEnumLSCEvent

Cette interface représente une liste d'événements de ILSCEvent.

Fonctions membres publics

IEnumLSCEvent::FNext

Récupère l'événement suivant à partir de la liste des événements.

HRESULT IEnumLSCEvent::FNext ( [out] ILSCEvent ** ppiLSCEvent )

Paramètres

ppiLSCEvent

Pointeur vers une interface ILSCEvent.

Valeurs renvoyées

Valeur

Description

E_FAIL

Il n'existe plus aucun événement.

S_OK

L'appel a réussi.

IEnumLSCEvent::Reset

Réinitialise l'énumérateur au premier événement.

HRESULT IEnumLSCEvent::Reset ( )

Paramètres

Aucun

Valeurs renvoyées

Renvoie toujours S_OK.

Interface ILSCEvent

Cette interface représente un événement de synchronisation. Toutes les informations relatives à l'événement peuvent être récupérées à partir de l'interface.

Fonctions membres publics

ILSCEvent::GetConflictStatus

Notez que cette valeur est renseignée lorsque ILSCLocalSyncClient::GetChanges est appelé, pas lorsque l'événement a été créé, afin que vous aurez seulement l'état actuel du fichier, pas l'état du fichier lors de la modification de l'état de conflit.

Cette valeur est remplie uniquement lorsque l' Enum LSCEventType de l'événement est LSCEventType_OnLocalConflictStateChanged.

HRESULT ILSCEvent::GetConflictStatus ( [out] VARIANT_BOOL * pfIsInConflict )

Paramètres

pfIsInConflict

L'état actuel de conflit de fichier associé à l'événement.

Valeurs renvoyées

Renvoie toujours S_OK.

ILSCEvent::GetError

Cette valeur est remplie uniquement lorsque l' Enum LSCEventType de l'événement est LSCEventType_OnServerChangesDownloaded ou LSCEventType_OnLocalChangesUploaded.

HRESULT ILSCEvent::GetError ( [out] LONG * pnError )

Paramètres

pnError

L'erreur est associée à cet événement.

Valeurs renvoyées

Renvoie toujours S_OK.

ILSCEvent::GetETag

Cette valeur est remplie uniquement lorsque l' Enum LSCEventType de l'événement est LSCEventType_OnServerChangesDownloaded ou LSCEventType_OnLocalChangesUploaded.

HRESULT ILSCEvent::GetETag ( [out] BSTR * pbstrETag )

Paramètres

pbstrETag

L'ETag associé à cet événement

Valeurs renvoyées

Renvoie toujours S_OK.

ILSCEvent::GetEventType

Obtient le type de cet événement.

HRESULT ILSCEvent::GetEventType ( [out] LSCEventType * pnEventType )

Paramètres

pnEventType

Le type d'événement de cet événement. Pour les valeurs valides, reportez-vous à la section Enum LSCEventType . Ne doit pas être null.

Valeurs renvoyées

Valeur

Description

E_INVALIDARG

Un ou plusieurs paramètres ne sont pas valides.

S_OK

L'appel a réussi.

ILSCEvent::GetLocalWorkingPath

Obtient le chemin d'accès local de travail de cet événement.

HRESULT ILSCEvent::GetLocalWorkingPath ( [out] BSTR * pbstrLocalWorkingPath )

Paramètres

pbstrLocalWorkingPath

Le chemin d'accès local du fichier vers lequel cet événement se rapporte.

Valeurs renvoyées

Renvoie toujours S_OK.

ILSCEvent::GetResourceID

Obtient l'ID de ressource pour l'événement.

HRESULT ILSCEvent::GetResourceID ( [out] BSTR * pbstrResourceID )

Paramètres

pbstrResourceID

ResourceID du fichier associé à cet événement.

Valeurs renvoyées

Renvoie toujours S_OK.

ILSCEvent::GetResourceIDAttempted

Cette valeur est remplie uniquement lorsque l' Enum LSCEventType de l'événement est LSCEventType_OnFilePathConflict. Lorsqu'un appel à ILSCLocalSyncClient::LocalFileChange, ILSCLocalSyncClient::ServerFileChangeou ILSCLocalSyncClient::RenameFile provoque un conflit de chemin d'accès au Web ou le chemin d'accès Local avec un autre fichier dans le cache de fichiers Office, cet événement est généré.

HRESULT ILSCEvent::GetResourceIDAttempted ( [out] BSTR * pbstrResourceIDAttempted )

Paramètres

pbstrResourceIDAttempted

ResourceID qui a provoqué l'événement à obtenir généré. Ne doit pas être null.

Valeurs renvoyées

Renvoie toujours S_OK.

ILSCEvent::GetSyncErrorType

Cette valeur est remplie uniquement lorsque l' Enum LSCEventType de l'événement est LSCEventType_OnServerChangesDownloaded ou LSCEventType_OnLocalChangesUploaded.

HRESULT ILSCEvent::GetSyncErrorType ( [out] LSCEventSyncErrorType * pnSyncErrorType )

Paramètres

pnSyncErrorType

Le type d'erreur associé à cet événement. Pour les valeurs possibles, reportez-vous à la section Enum LSCEventType . Ne doit pas être null.

Valeurs renvoyées

Valeur

Description

E_INVALIDARG

Un ou plusieurs paramètres ne sont pas valides.

S_OK

L'appel a réussi.

ILSCEvent::GetWebPath

Cette valeur est remplie uniquement lorsque l' Enum LSCEventType de l'événement est LSCEventType_OnFilePathConflict.

HRESULT ILSCEvent::GetWebPath ( [out] BSTR * pbstrWebPath )

Paramètres

pbstrWebPath

Spécifie le chemin d'accès Web associé à cet événement. Ne doit pas être null.

Valeurs renvoyées

Renvoie toujours S_OK.

Interface ILSCEvent2

Cette interface conserve des informations supplémentaires sur un événement de synchronisation.

Fonctions membres publics

ILSCEvent2::GetErrorChain

Obtient les informations de la chaîne d'erreur à propos d'un événement de synchronisation.

HRESULT ILSCEvent2::GetErrorChain ( [out] BSTR * pbstrErrorChain )

Paramètres

pbstrErrorChain

Une chaîne contenant les informations de la chaîne d'erreur. Ne doit pas être null.

Valeurs renvoyées

Valeur

Description

E_NOTIMPL

La version installée de Office ne prend pas en charge cette interface

E_INVALIDARG

Un ou plusieurs des valeurs de paramètre ne sont pas valides.

E_FAIL

Les informations de la chaîne d'erreur ne sont pas disponibles.

S_OK

L'appel a réussi.

Interface IPartnerActivityCallback

Cette interface fournit une fonction de rappel à l'objet COM de CSISyncClient.

Fonctions membres publics

IPartnerActivityCallback::EventOccurred

Il s'agit d'une fonction de rappel sur l'objet donné à l'objet COM de CsiSyncClient. Il est prévu que lorsqu'un événement se produit (pour les types d'événements valides, voir Enum LSCEventTypeOccurred ), l'objet COM de CsiSyncClient appelle cette méthode, le consommateur de signalisation.

HRESULT IPartnerActivityCallback::EventOccurred ( [in] LSCEventTypeOccurred eEventTypeOccurred )

Paramètres

eEventTypeOccurred

Le type d'événement de cet événement. Pour les valeurs valides, reportez-vous à la section Enum LSCEventTypeOccurred .

Valeurs renvoyées

Renvoie toujours S_OK.

CSISyncClient utilise les énumérations suivantes.

Enum LSCEventSyncErrorType

Cette énumération spécifie les catégories d'erreurs qui peuvent se produire lors de la synchronisation d'un fichier.

Énumérateur

Description

LSCEventSyncErrorType_UserInterventionRequiredUnexpected

L'erreur de synchronisation de cet événement n'était pas prévu et peut-être nécessiter une attention particulière. Par défaut, l'utilisateur peut avoir à intervenir.

LSCEventSyncErrorType_NoInterventionRequired

L'erreur de synchronisation de cet événement ne doit pas une attention particulière. Office qu'il gère automatiquement.

LSCEventSyncErrorType_UserInterventionRequired

L'erreur de synchronisation de cet événement requiert un utilisateur à sa résolution. Par exemple, erreur de conflit de fusion requiert un utilisateur ouvrir le document et les fusionner.

LSCEventSyncErrorType_WaitingOnClient

L'erreur de synchronisation de cet événement requiert le consommateur intervenir, mais ne nécessitent ne pas une attention particulière par l'utilisateur.

LSCEventSyncErrorType_ClientInterventionRequired

L'erreur de synchronisation de cet événement requiert le consommateur intervenir comme un cas spécial.

LSCEventSyncErrorType_Max

Enum LSCEventType

Cette énumération spécifie le type des événements qui peuvent se produire pour un fichier particulier.

Énumérateur

Description

LSCEventType_None

LSCEventType_OnLocalChanges

Modifications apportées à un fichier local.

LSCEventType_OnOpenedByUser

Un utilisateur ouvre un fichier.

LSCEventType_OnServerChangesDownloaded

Terminé le téléchargement des modifications de fichiers à partir du serveur.

LSCEventType_OnLocalChangesUploaded

Terminé le téléchargement des modifications apportées aux fichiers sur le serveur.

LSCEventType_OnLocalConflictStateChanged

L'état de conflit de fusion d'un fichier a changé.

LSCEventType_OnFileAdded

Un fichier a été ajouté.

LSCEventType_OnFileDeleted

Un fichier a été supprimé.

LSCEventType_OnSyncEnabled

Synchronisation a été activé pour les fichiers d'un utilisateur.

LSCEventType_OnServerChangesDownloadStarted

Démarrer le téléchargement des modifications de fichiers à partir du serveur.

LSCEventType_OnLocalChangesUploadStarted

Démarrer le téléchargement des modifications apportées aux fichiers sur le serveur.

LSCEventType_OnFilePathConflict

Cet événement est généré lorsqu'un appel à ILSCLocalSyncClient::LocalFileChange, ILSCLocalSyncClient::ServerFileChangeou ILSCLocalSyncClient::RenameFile provoque un conflit de chemin d'accès au Web ou le chemin d'accès Local avec un autre fichier dans le cache de fichier Office.

LSCEventType_OnFileForked

LSCEventType_Max

Enum LSCEventTypeOccurred

Cette énumération spécifie le type des événements qui peuvent se produire. Le consommateur doit appeler des fonctions ILSCLocalSyncClient spécifiques en fonction du type d'événement.

Énumérateur

Description

LSCEventTypeOccurred_GetChanges

Un ILSCEvent s'est produite. Le consommateur doit appeler ILSCLocalSyncClient::GetChanges pour récupérer les données.

LSCEventTypeOccurred_GetSupportedFileExtensions

Les extensions de fichiers pris en charge ont été modifiées. Le consommateur doit appeler ILSCLocalSyncClient::GetSupportedFileExtensions pour récupérer la nouvelle liste des extensions prises en charge.

Enum LSCNetworkSyncPermissionType

Cette énumération spécifie les indicateurs utilisés pour une heuristique de coût du réseau.

Énumérateur

Description

LSCNetworkSyncPermissionType_HighCost

True si l'heuristique de coût pour les réseaux coûteux (par exemple, 3 G) est remplacé.

LSCNetworkSyncPermissionType_HighPowerUsage

True si l'heuristique de coût de consommation d'énergie (par exemple, une batterie) est remplacé.

Enum LSCStatusFlag

Cette énumération est utilisée pour représenter l'état de synchronisation d'un fichier.

Énumérateur

Description

LCSStatusFlag_None

LSCStatusFlag_UploadPending

True si les données à envoyer vers le serveur en attente.

LSCStatusFlag_DownloadPending

True si les données à télécharger à partir du fichier de serveur en attente.

LSCStatusFlag_LocalFileUnchanged

True si les données Office a sur le fichier dans son cache est la plus récente copie des données sur le disque.

Afficher: