GetArchiveName Method (archiveNumber)

DTF API

previous page next page

Deployment Tools Foundation GetArchiveName Method (archiveNumber)

Gets the name of the archive with a specified number.

Declaration Syntax

Visual Basic

Visual C++

public virtual string GetArchiveName(
	int archiveNumber
)

Public Overridable Function GetArchiveName ( 
	archiveNumber As Integer
) As String

public:
virtual String^ GetArchiveName(
	int archiveNumber
)

abstract GetArchiveName : 
        archiveNumber : int -> string 
override GetArchiveName : 
        archiveNumber : int -> string

Parameters

archiveNumber (Int32): The 0-based index of the archive within the chain.

Return Value

String
The name of the requested archive. May be an empty string for non-chained archives, but may never be null.

Remarks

This method returns the file name of the archive from the archiveFiles()()()() list with the specified index, or an empty string if the archive number is outside the bounds of the list. The file name should not include any directory path.

Assembly: Microsoft.Deployment.Compression (Module: Microsoft.Deployment.Compression.dll) Version: 3.0.0.0 (3.11.1.2318)

previous page start next page