_DTSPredictor::get_CustomRename, put_CustomRename Property [C++]

Article
11/12/2009

The CustomRename property is a read/write String that contains a custom suffix to be appended to the name of the model.

Definition

[C++]

Get method:

HRESULT _DTSPredictor::get_CustomRename(
BSTR CustomRename
);

Put method:

HRESULT _DTSPredictor::put_CustomRename(
BSTR* CustomRename
);

[Visual Basic]

Property CustomRename() As String

Parameters

CustomRename[C++]

[in] When putting a property, a BSTR that is used as a custom suffix to be appended to the name of the model.
[out, retval] When getting a property, a pointer to a BSTR that is used as the custom suffix to be 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

The CustomRename property is only used if the ArchiveType property is set to archtypeCustom(2).

Share via