# LibTmux\Get-TmuxQueryField

- **Package:** LibTmux
- **Language:** PowerShell
- **Kind:** function
- **Source:** https://github.com/libtmux/libtmux-powershell/blob/b06c64f844f3173de66b187eaeaf3915814318c6/src/LibTmux.PowerShell/GetTmuxQueryFieldCommand.cs#L7
- **Page:** https://libtmux.org/en/powershell/latest/reference/libtmux-get-tmuxqueryfield/

```
Get-TmuxQueryField
    [-Target] <LibTmux.Query.QueryTarget>
    [<CommonParameters>]
```

Discover query fields, operators and native bindings.

Return immutable descriptors from the shared [`LibTmux`](/en/powershell/latest/reference/libtmux/) field catalog. Each
descriptor identifies the wire field, supported operations, capture depth and
native bindings. Discovery is local and requires no server or tmux executable.
[`Client`](/en/csharp/latest/reference/libtmux-client/) descriptors are available for inspection; the PowerShell structured
selectors accept [`Session`](/en/csharp/latest/reference/libtmux-session/), [`Window`](/en/csharp/latest/reference/libtmux-window/) and [`Pane`](/en/csharp/latest/reference/libtmux-pane/) targets. [`Operators`](/en/csharp/latest/reference/libtmux-query-queryfielddescriptor-operators/) use the native
wire vocabulary: greaterThanOrEqual corresponds to the PowerShell criteria
key Ge. See the [criteria keys](https://github.com/libtmux/libtmux-powershell/blob/b06c64f844f3173de66b187eaeaf3915814318c6/docs/query.md#criteria-vocabulary) for the full mapping.

### Notes

Catalog discovery does not refresh captured objects.

## Command details

- **Command type:** [`cmdlet`](/en/powershell/latest/reference/glossary/#cmdlet)
- **Positional binding:** Enabled.
- **Pipeline inputs:** `None`: No pipeline input.
- **Outputs:** `LibTmux.Query.QueryFieldDescriptor`

Related APIs:

- [`New-TmuxQuery`](/en/powershell/latest/reference/libtmux-new-tmuxquery/)

## Examples

Example 1

Inspect the pane-width field and its supported operations.

[Source example](https://github.com/libtmux/libtmux-powershell/blob/b06c64f844f3173de66b187eaeaf3915814318c6/docs/reference/LibTmux/Get-TmuxQueryField.md).

```powershell
LibTmux\Get-TmuxQueryField -Target Pane | Where-Object WireName -EQ 'pane_width'
```

## Parameters

- `Target` (`LibTmux.Query.QueryTarget`): The entity whose catalog fields are returned.
  Required. Position 0. Does not accept pipeline input. [`ValidateSet(["Session","Window","Pane","Client"])`](https://learn.microsoft.com/dotnet/api/system.management.automation.validatesetattribute?view=powershellsdk-7.4.0).
- `Verbose` (`System.Management.Automation.SwitchParameter`): Display verbose messages produced by this command.
  Optional. Named parameter. Switch parameter. Common parameter. Does not accept pipeline input. Aliases: `vb`.
- `Debug` (`System.Management.Automation.SwitchParameter`): Display debug messages produced by this command.
  Optional. Named parameter. Switch parameter. Common parameter. Does not accept pipeline input. Aliases: `db`.
- `ErrorAction` (`System.Management.Automation.ActionPreference`): Choose how this command responds to non-terminating errors.
  Optional. Named parameter. Common parameter. Does not accept pipeline input. Aliases: `ea`.
- `WarningAction` (`System.Management.Automation.ActionPreference`): Choose how this command responds to warning messages.
  Optional. Named parameter. Common parameter. Does not accept pipeline input. Aliases: `wa`.
- `InformationAction` (`System.Management.Automation.ActionPreference`): Choose how this command handles information messages.
  Optional. Named parameter. Common parameter. Does not accept pipeline input. Aliases: `infa`.
- `ProgressAction` (`System.Management.Automation.ActionPreference`): Choose how this command handles progress updates.
  Optional. Named parameter. Common parameter. Does not accept pipeline input. Aliases: `proga`.
- `ErrorVariable` (`System.String`): Store the command's error records in the named variable.
  Optional. Named parameter. Common parameter. Does not accept pipeline input. Aliases: `ev`.
- `WarningVariable` (`System.String`): Store the command's warning records in the named variable.
  Optional. Named parameter. Common parameter. Does not accept pipeline input. Aliases: `wv`.
- `InformationVariable` (`System.String`): Store the command's information records in the named variable.
  Optional. Named parameter. Common parameter. Does not accept pipeline input. Aliases: `iv`.
- `OutVariable` (`System.String`): Save output in the named variable while passing it down the pipeline.
  Optional. Named parameter. Common parameter. Does not accept pipeline input. Aliases: `ov`.
- `OutBuffer` (`System.Int32`): Buffer output before passing it to the next pipeline command.
  Optional. Named parameter. Common parameter. Does not accept pipeline input. Aliases: `ob`.
- `PipelineVariable` (`System.String`): Make the most recent output object available through a named variable within the pipeline.
  Optional. Named parameter. Common parameter. Does not accept pipeline input. Aliases: `pv`.

## Returns

`LibTmux.Query.QueryFieldDescriptor`: Native descriptors in wire-name order.