---
title: clsBatchReturnInfo
summary: API reference for clsBatchReturnInfo.
status: draft
owner: SAIF Doc Gen
last_reviewed: 2026-07-24
library: SAIF.Services.CleanAddress
reference_type: package
---

# clsBatchReturnInfo

`clsBatchReturnInfo` is the DTO returned by `RunCleanAddressBatch()`. It preserves both the raw numeric return code from the vendor service and the normalized enum value used by calling code.

## Purpose
- Hold batch-execution status in both raw and normalized forms.

## Context
- Namespace: `SAIF.Services.CleanAddress`
- Assembly/package: `SAIF.Services.CleanAddress`

## Public members
| Member | Signature | Purpose |
| --- | --- | --- |
| `BatchReturnValue` | `Public Property BatchReturnValue As BatchReturnTypes` | Returns the normalized batch outcome selected by the wrapper logic. |
| `ReturnValue` | `Public Property ReturnValue As Integer` | Returns the raw integer code produced by the vendor batch operation. |

## Behavioral notes
- `BatchReturnValue` is assigned according to [BR-004](../../business-rules.md#br-004-batch-return-code-mapping).

## Constraints and usage notes
- The wrapper always returns both properties together so callers can inspect either the normalized enum or the original vendor code.

## Sources
- `Services\SAIF.Services.CleanAddress\clsBatchReturnInfo.vb`
- `Services\SAIF.Services.CleanAddress\clsCleanAddress.vb`
- `Services\SAIF.Services.CleanAddress\mdlEnums.vb`