Files an instance of a Containable subclass to this folder. Depending on the Containable subclass filed, a ReferentialContainmentRelationship object (for CustomObject and Folder objects) or a DynamicReferentialContainmentRelationship (for Document objects) is created to reference this folder and the containee (instance filed).


Namespace: FileNet.Api.Core
Assembly: FileNet.Api (in filenet.api.dll)

Syntax

Visual Basic (Declaration)
Function File( _ 
   ByVal containee As IIndependentlyPersistableObject,  _ 
   ByVal autoUniqueName As AutoUniqueName,  _ 
   ByVal containmentName As String,  _ 
   ByVal defineSecurityParentage As DefineSecurityParentage _ 
) As IReferentialContainmentRelationship
C#
IReferentialContainmentRelationship File(
   IIndependentlyPersistableObject containee,
   AutoUniqueName autoUniqueName,
   string containmentName,
   DefineSecurityParentage defineSecurityParentage
)
C++
IReferentialContainmentRelationship File(
   IIndependentlyPersistableObject containee,
   AutoUniqueName autoUniqueName,
   String containmentName,
   DefineSecurityParentage defineSecurityParentage
) abstract 
J#
IReferentialContainmentRelationship File(
   IIndependentlyPersistableObject containee,
   AutoUniqueName autoUniqueName,
   string containmentName,
   DefineSecurityParentage defineSecurityParentage
)
JScript
function File(
   containee : IIndependentlyPersistableObject,
   autoUniqueName : AutoUniqueName,
   containmentName : String,
   defineSecurityParentage : DefineSecurityParentage
) : IReferentialContainmentRelationship

Parameters

containee
An IndependentlyPersistableObject object for the Containable subclass instance to be filed.
autoUniqueName
An AutoUniqueName object indicating whether to detect and resolve naming collisions of containment names.
containmentName
A String containing the containment name to assign to the new object. By default, this is the file name of the object. The following characters are not allowed: \ / : * ? " < > |
defineSecurityParentage
A DefineSecurityParentage object indicating whether the containing folder is to be used as a security parent. If so, the SecurityFolder property of the object being added is automatically set to this folder.

Return Value

A ReferentialContainmentRelationship object where this folder is the tail and the object filed (containee) is the head.

See Also