GetFileVersionDeleteRestrictionsByMasterIds Method
Gets any restrictions on deleting a specific versions of Files. This function can be used to pre-check any issues before running DeleteFileVersionsByMasterIds.
Required Permissions
PurgeFilesSyntax
public FileDelRestricEx[] GetFileVersionDeleteRestrictionsByMasterIds(
System.long[] fileMasterIds,
System.bool deleteUncontrolledVersions,
System.int keepCount,
System.int minAge,
System.string comment
)Public Function GetFileVersionDeleteRestrictionsByMasterIds( _
ByVal fileMasterIds() As System.Long, _
ByVal deleteUncontrolledVersions As System.Boolean, _
ByVal keepCount As System.Integer, _
ByVal minAge As System.Integer, _
ByVal comment As System.String _
) As FileDelRestricEx()Parameters
| Name | Description |
|---|---|
| fileMasterIds | An array of File Masters IDs. |
| deleteUncontrolledVersions | If false, all versions that can be purged are purged. If true, the versions purged are dependent on the next 3 parameters. |
| keepCount | The number of versions to keep. Example: If there are 10 versions of a file and this value is 7, then only the first 3 versions will be deleted. This parameter is only used if deleteUncontrolledVersions is true. |
| minAge | The minimum age, in days, that a version has to be. Example: If this value is 60, then only versions older than 60 days will be deleted. This parameter is only used if deleteUncontrolledVersions is true. |
| comment | Versions will not be deleted if this value is in the comment. Example: If this value is 'approved', then versions with the word 'approved' in the comment text will not be deleted. This parameter is only used if deleteUncontrolledVersions is true. |
Return Value
An array of restrictions for the operation. Null will be returned if there are no restrictions.