_DTSPredictor::get_ArchiveType, put_ArchiveType Property [C++]

Article
11/12/2009

The ArchiveType property is a read/write Integer enumeration that contains the suffix to be concatenated to the name of the model if an archive option is used.

Definition

[C++]

Get method:

HRESULT _DTSPredictor::get_ArchiveType(
short ArchiveTypeEnum
);

Put method:

HRESULT _DTSPredictor::put_ArchiveType(
short* ArchiveTypeEnum
);

[Visual Basic]

Property ArchiveType() As Integer

Parameters

ArchiveTypeEnum[C++]

[in] When putting a property, a short that is used to determine the type of suffix appended to the name of the model.
[out, retval] When getting a property, a pointer to a short used to identify the type of suffix appended to the name of the model.

None.[Visual Basic]

[C++]

Return Values

These methods return an HRESULT indicating whether they completed successfully. See the Error Values section for more details.

Error Values

[C++] These methods return S_OK (0x00000000) to indicate success and standard COM HRESULT error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object, which can be accessed using the API function GetErrorInfo. In particular, the GetDescription method of the IErrorInfo interface may return a text description of the error.

[Visual Basic] This property sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to standard COM error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object. In particular, the Description property may contain a text description of the error.

Remarks

If the ArchiveType property is set to archtypeDate (0), the suffix will contain the date. If the ArchiveType property is set to archivetypeVersion (1), the suffix will contain the version number. If the ArchiveType property is set to archtypeCustom (2), the suffix will contain the custom suffix specified by the CustomRename property. If the ArchiveType property is set to archtypeNone (-1), no suffix will be added.