_CatalogToVendorAssociation::GetVendorList Method [C++]

Article
11/12/2009

Use this method to retrieve a list of vendors associated with the passed alias qualifier and value, and associated with the input document name.

Definition

[C++]

HRESULT _CatalogToVendorAssociation::GetVendorList(BSTRszSourceAliasQualifier,
  BSTRszSourceAliasValue,
  BSTRszInputDocumentName,
  _Recordset**rsVendorList);

[Visual Basic]

Function GetVendorList(szSourceAliasQualifier As String,
  szSourceAliasValue As String,
  szInputDocumentName As String) As Recordset

Parameters

szSourceAliasQualifier[C++]
[in] A BSTR that contains the source alias qualifier.
szSourceAliasQualifier[Visual Basic]
A String that contains the source alias qualifier.
szSourceAliasValue[C++]
[in] A BSTR that contains the source alias value.
szSourceAliasValue[Visual Basic]
A String that contains the source alias value.
szInputDocumentName[C++]
[in] A BSTR that contains the input document name.
szInputDocumentName[Visual Basic]
A String that contains the input document name.
rsVendorList [C++]
[out, retval] The address of a pointer used to return an ADO _Recordset object containing the requested list of vendors.

Return Values

[C++] This method returns an HRESULT indicating whether it completed successfully. See the Error Values section for more details.

[Visual Basic] If this method completes successfully, it returns an ADO Recordset object containing the requested list of vendors.

Error Values

[C++] This method returns 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 method 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 returned ADO RecordSet object will contain valid data only if the method completed successfully.

Note

This method is only available when BizTalk Server is installed. It requires the BizTalKDBInternal object.

For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.

Example