Skip to content

BSL193 — Out function parameter

← All rules

Summary

Out function parameter

Identifiers

Field Value
Rule code BSL193
Compatible alias FunctionOutParameter
Severity WARNING
Enabled by default Yes
Implemented Yes
Tags design

Behavior

  • The public identifier BSL193 and alias FunctionOutParameter are stable.
  • The rule reports the cases documented on this page.
  • Suppressions and project configuration are applied before publication.
  • The rule requires neither an external analyzer nor network access.

Configuration and suppression

BSL### is the primary stable identifier. The compatible alias is accepted in select, ignore, and compatible block suppression comments.

[tool.onec-hbk-bsl]
select = ["BSL193"]
ignore = ["FunctionOutParameter"]

All three suppression families support both a current line and a range. When an opening comment follows code, it affects only that line. Use any one form:

  • noqa:
Value = "example";  // noqa: BSL193
  • bsl-disable:
Value = "example";  // bsl-disable: BSL193
  • compatible BSLLS form:
Value = "example";  // BSLLS:FunctionOutParameter-off

When the same opening comment is on a line by itself, it starts a range. Close it with the matching marker from the same family:

// noqa: BSL193
// code without this diagnostic
// noqa-enable: BSL193

// bsl-disable: BSL193
// code without this diagnostic
// bsl-enable: BSL193

// BSLLS:FunctionOutParameter-off
// code without this diagnostic
// BSLLS:FunctionOutParameter-on

To disable the rule until the end of the file, omit the closing noqa-enable, bsl-enable, or BSLLS:…-on marker.

Opening and closing markers must belong to the same family.

Description

The function must have no output parameters. All output must be in the return value. If you need to return multiple values, you should use such types as Structure, Array, etc.

Examples

// Incorrect:
ServiceURL = "";
UserName = "";
UserPassword = "";

FillConnectionParameters(ServiceURL, UserName, UserPassword);

// Correct:
ConnectionParameters = NewConnectionParameters();
// Returned value - Structure:
//     Service URL  - String
//     UserName     - String
//     UserPassword - String

Sources