$doc.deserialize

Description

Restore un ou plusieurs dossiers à partir d'une représentation sérialisée (voir $doc.serialize() pour construire la version sérialisée d'un ou plusieurs documents).

Syntaxe

$doc.deserialize( data [ , options ] )

Paramètres

data string / file

Donnée à désérialiser. La donnée peut être un file ou du texte. Attention, dans ce cas le texte n'est pas censé désigner le path d'un fichier, mais le texte sérialisé à traiter.

options map

Map d'options. Les options reconnues sont:

format string

Format des données. Les types reconnus sont xml, json ou auto. La valeur par défaut est auto. Dans ce cas, la méthode essaie de deviner le format en fonction des premiers caractères de la valeur sérialisée.

keepDocumentOpen boolean

Flag true/false indiquant de garder le ou les dossiers chargés ouverts. Une erreur est déclenchée si les données d'entrées référencent plusieurs dossiers alors que l'application n'autorise pas le multi-dossier.

L'option est false par défaut pour les applications qui utilisent une base de données et true par défaut pour les application qui n'ont pas de base de données.

docExistAction string

Comportement que la méthode doit avoir si le dossier que l'on cherche à restaurer existe déjà. Les valeurs possibles sont:

• cancel: Le dossier n'est pas traité (la désérialisation du dossier est annulée et le traitement continue avec les éventuels autres dossiers à désérialiser)
• replace: Le dossier existant est remplacé

La valeur par défaut est cancel

Retour

Retourne un tableau contenant les contextes des dossiers chargés.

Exemple

Exemple de code désérialisant tous les dossiers présents dans un fichier.

var file = $file.load("C:/Temp/docs.xml");
$doc.deserialize(file);