In a Cmdlet, how can I detect if the Debug flag is set?

Question

I'm writing a PowerShell Cmdlet and using WriteDebug, but I want to write an object which requires an extra API call, and I'd rather not make that call when debugging is turned off. How can I detect whether the Debug flag is set or not, so that I can skip this call to WriteDebug entirely?

For example, my WriteDebug call will look something like this:

WriteDebug(string.Format("Name : {0}", api.GetName(myobj)));

In that example, I want to avoid the call to api.GetName unless debugging is turned on.

Answer 1

Try this:

$Debug = $psboundparameters.debug.ispresent


if ($Debug){
  Write-Debug(string.Format("Name : {0}", api.GetName(myobj))
  }