ConnectionUpdateDocument Method |
Updates the properties and/or content information of a document.
Namespace: ICMeridianAPIAssembly: ICMeridianAPI (in ICMeridianAPI.dll) Version: 4.0.8.0 (4.0.8.0)
Syntaxpublic void UpdateDocument(
string vaultidentifier,
string docid,
string sourcefilefullpath = "",
Object properties = null,
Object values = null
)
Public Sub UpdateDocument (
vaultidentifier As String,
docid As String,
Optional sourcefilefullpath As String = "",
Optional properties As Object = Nothing,
Optional values As Object = Nothing
)
public:
void UpdateDocument(
String^ vaultidentifier,
String^ docid,
String^ sourcefilefullpath = L"",
Object^ properties = nullptr,
Object^ values = nullptr
)
member UpdateDocument :
vaultidentifier : string *
docid : string *
?sourcefilefullpath : string *
?properties : Object *
?values : Object
(* Defaults:
let _sourcefilefullpath = defaultArg sourcefilefullpath ""
let _properties = defaultArg properties null
let _values = defaultArg values null
*)
-> unit
Parameters
- vaultidentifier
- Type: SystemString
The vault in which the document resides. - docid
- Type: SystemString
The unique identifier of the document inside the vault. - sourcefilefullpath (Optional)
- Type: SystemString
Optional string. A local source file that provides the new document content.
If no source file is provided, the document is left unchanged.
The source file can also be specified as %<templatename>, where <templatename> is the internal name
of the template file associated with the document type of the document. - properties (Optional)
- Type: SystemObject
Optional variant array of property names that need to be set with values. - values (Optional)
- Type: SystemObject
Optional variant array of values for the properties provided in the properties parameter.
The length of the lists should be identical.
RemarksThe values array must be an array of variants.
The document has to be checked out when updating the document content.
It is not necessary to update the properties and document at the same time. You can update
either the properties or the content or both. Just leave the unused parameters empty.
See Also