LOFREQUEST Field - log_file_ID

log_file_ID (PULONG) - input/output

A pointer to an area that contains an integer ID of the file to be opened.

On input, specifies the number of the file that you wish to open. There can be various combinations of log_file_ID and filename requests. The following table shows what will happen in each case.

┌────────────┬──────────┬───────────────────────────────────┐
│Contents of │Contents  │What happens                       │
│log_file_ID │of        │                                   │
│            │file_name │                                   │
├────────────┼──────────┼───────────────────────────────────┤
│A number was│A name was│The file_name is ignored           │
│entered     │entered   │If log_file_ID exists, the file is │
│            │          │opened and a new log_file_ID number│
│            │          │is assigned.                       │
│            │          │If log_file_ID does not exist, a   │
│            │          │failing return code is returned.   │
├────────────┼──────────┼───────────────────────────────────┤
│A number was│NULL      │If log_file_ID exists, the file is │
│entered     │          │opened and a new log_file_ID number│
│            │          │is assigned.                       │
│            │          │If log_file_ID does not exist, a   │
│            │          │failing return code is returned.   │
├────────────┼──────────┼───────────────────────────────────┤
│NULL        │A name was│If the file exists, the file is    │
│            │entered   │opened and a new log_file_ID number│
│            │          │is assigned.                       │
│            │          │If the file does not exist, a      │
│            │          │failing return code is returned.   │
└────────────┴──────────┴───────────────────────────────────┘

On output, contains the number of the file that was opened.

---

[Back: LOFREQUEST Field - packet_revision_number]
[Next: LOFREQUEST Field - filename_length]