libfossil
fsl_ckout_unmanage_state Struct Reference

State passed to fsl_ckout_unmanage_f() callback. More...

#include "checkout.h"

Collaboration diagram for fsl_ckout_unmanage_state:

Data Fields

fsl_cx * f
 The fsl_cx instance for the correspnding fsl_ckout_unmanage() call.
char const * filename
fsl_ckout_unmanage_opt const * opt
 The options object passed to the corresponding call to fsl_ckout_unmanage().

Detailed Description

State passed to fsl_ckout_unmanage_f() callback.

Definition at line 408 of file checkout.h.

Field Documentation

◆ f

fsl_cx* fsl_ckout_unmanage_state::f

The fsl_cx instance for the correspnding fsl_ckout_unmanage() call.

Definition at line 413 of file checkout.h.

◆ filename

char const* fsl_ckout_unmanage_state::filename
 The name of the file being unmanaged, relative to the root of the
 checkout. fsl_cx_stat2() can be used to transform it to an
 absolute path, if needed. Given a fsl_ckout_unmanage_state
 named `ums`, that call would look like:

 ```
 fsl_buffer_reuse(&yourBuffer);

^^^ noting that fsl_cx_stat2() APPENDS to the buffer. int rc = fsl_cx_stat2(ums->f, false, ums->filename, NULL, &yourBuffer, true); ^^^ noting that the stat will legitimately and harmlessly fail if the file does not exist, so this error can normally be ignored. ```

Definition at line 438 of file checkout.h.

◆ opt

fsl_ckout_unmanage_opt const* fsl_ckout_unmanage_state::opt

The options object passed to the corresponding call to fsl_ckout_unmanage().

This is provided primarily for access to its callbackState member. The client must never modify any state in this opt object other than the callbackState or to use other APIs of this->f.

Definition at line 421 of file checkout.h.


The documentation for this struct was generated from the following file: