The ImportPackage object represents the current import package.
ImportPackage Object Properties
The ImportPackage object provides the following properties, all of which are read-only. They are described below.
Description Property
Gets or sets the description of the current package.
Syntax
Description As String
Remarks
The package must be in the Open status to set the value.
ID Property
Returns the ID of the current object. The value is unique within the current vault. For the ID value that is unique among all vaults, retrieve the GlobalID property value, if available. Read-only.
Syntax
ID As String
Name Property
Returns the name of the current object. Depending on the object type, this property returns the display name of the object or it returns the internal name and may be read-only.
Syntax
Name As String
Remarks
If the current object is a Package, it must be in the Open status to set the value.
If the current object is a User, this property is the short name of the user as stored in the user's Meridian account information and is read-only. This property can be used to specify the recipient's email address and either an empty string or no value set in the Address property. If an email address is specified in Name, it must be surrounded with carets (<>). When used with Microsoft Outlook, the Name property may contain the user's full name or last name and Outlook will attempt to resolve the name to the email address in the default address book.
ImportProfile Property
Gets the ImportProfile object that is assigned to the current ImportPackage object.
Syntax
ImportProfile As Object
ImportPackage Object Methods
The ImportPackage object methods affect the current import package. They are described below.
GetDocuments Method
Gets the documents contained in the current package.
Syntax
GetDocuments() As Array
Return Value
Returns an array of GlobalID values for the documents.
Remarks
When the current package is an import package, returns an array only if the Status property of the package is AS_IPS_Imported.