IBTBatchTransmitter.GetBatch Method (COM)

 

Returns a new batch that will be used by the BizTalk Server Messaging Engine, which will push messages to be transmitted into the batch.

Syntax

  
HRESULT IBTBatchTransmitter::GetBatch(  
IBTTransmitterBatch**  
ppBatch  
);  
  

  
Function GetBatch
() As IBTTransmitterBatch  
  

Remarks

Parameters

ppBatch
[out,retval] Pointer to hold the reference to the returned IBTTransmitterBatch object/interface, which will contain the new adapter batch.

None.

Return Values

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

If this method completes successfully, it returns the IBTTransmitterBatch containing the new adapter batch.

Error Values

This method returns an HRESULT containing one of the values in the following table.

This method indicates errors by setting the Number property of the global Err object to one of the values in the following table.

Value	Description
S_OK	The method completed successfully.

Requirements

Platforms:  Windows

See Also

IBTBatchTransmitter Interface (COM)
IBTBatchTransmitter Members (COM)