---
name: "function::return_str"
section: "3stap"
platform: "linux"
package: "systemtap-doc"
version: "5.1-5"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/function::return_str"
---

# function::return\_str(3stap)

Formats the return value as a string

## NAME

function::return\_str - Formats the return value as a string

## SYNOPSIS

```
    return_str:string(format:long,ret:long)
```

## ARGUMENTS

*format*

Variable to determine return type base value

*ret*

Return value (typically **$return**)

## DESCRIPTION

This function is used by the syscall tapset, and returns a string. Set format equal to 1 for a decimal, 2 for hex, 3 for octal.

Note that this function is preferred over **returnstr**.

## SEE ALSO0

[*tapset::errno*(3stap)](/tapset::errno/3stap.md)