Microsoft/bcquality
1
0
Fork 0
mirror of https://github.com/microsoft/BCQuality.git synced 2026-10-05 14:46:55 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
bcquality/microsoft/knowledge/style/error-passes-parameters-directly-not-strsubstno.md
Jesper Schulz-Wedde 2b5550c346
Some checks failed
Validate knowledge index / validate-index (push) Has been cancelled
Details
Validate AL review fixtures / validate-review-fixtures (push) Has been cancelled
Details
Validate frontmatter and structure / validate (push) Has been cancelled
Details
Improve partner onboarding and documentation navigation (#174) 
Lead with a complete plugin quick start and add task-oriented usage, troubleshooting, customization, and contribution guides. Preserve the broader plugin framing, correct conflicting contract guidance, support Agents folder reviews, and align repository validation. Convert existing sample references to clickable links without changing knowledge rules.

Co-authored-by: Jesper Schulz-Wedde <jesper.schulzwedde@microsoft.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
2026-09-09 17:31:03 +02:00

1.9 KiB
Raw Permalink Blame History

bc-version domain keywords technologies countries application-area
all
style
error
strsubstno
label
parameters
concatenation
aa0231
al
w1
all

Pass parameters directly to Error(), do not wrap with StrSubstNo

Description

Error() accepts a format string and a variable number of arguments — Error(SomeLabelErr, Arg1, Arg2). The platform performs the substitution itself, which is the path the translation pipeline understands. Wrapping the same call as Error(StrSubstNo(SomeLabelErr, Arg1, Arg2)) hides the placeholders from the platform and removes the format-string identity from the call-site, so analyzers cannot match the call to its label and translators lose the link between the formatted message and its template. The corresponding anti-pattern for hardcoded strings — Error('Customer ' + CustomerNo + ' not found') — is even worse: it builds an untranslatable, unanalyzable string at runtime.

Best Practice

Declare a Label with the Err suffix and the appropriate Comment for placeholders, then call Error(YourErr, arg1, arg2). The same rule applies to Message, Confirm, and other UI primitives: format string in, parameters as separate arguments, no StrSubstNo wrapper at the call site, no string concatenation. An Error('') (empty message) is acceptable when the calling code expects another layer to emit the actual diagnostic.

See sample: error-passes-parameters-directly-not-strsubstno.good.al.

Anti Pattern

Error(StrSubstNo(CustomerNotFoundErr, CustomerNo)) and Error(CustomerNotFoundErr + ': ' + CustomerNo) both defeat the translation and analysis machinery. Reviewers should treat StrSubstNo appearing as an argument to Error, Message, Confirm, or StrMenu as an unconditional signal to rewrite.

See sample: error-passes-parameters-directly-not-strsubstno.bad.al.