TMDeleteFile Overview Group

The TMDeleteFile API call deletes the file specified in the FileEntry structure 'fentry'. Only the 'name' and 'extension' portions of 'fentry' need be set before calling TMDeleteFile. The file must be in the current directory on the current device on the 1-Wire network specified by the session handle 'session_handle'.


short far pascal TMDeleteFile(

long session_handle,    // session handle for the desired 1-Wire network
void far *state_buffer, // state buffer provided for the 1-Wire network session
FileEntry far *fentry   // pointer to a structure with the file information
);

For a description of the above types, see the TMEX Type Descriptions.

Parameters

session_handle

Specifies the session handle returned from the API function TMExtendedStartSession that specifies the desired 1-Wire network port. This parameter is required by most TMEX API functions.

state_buffer

Specifies a pointer to a memory location that TMEX keeps all of the state information for the 1-Wire networks. This parameter is required by most TMEX API functions.

fentry

Specifies a pointer to a memory location that contains a FileEntry structure. This structure must have the name and extension portions set before calling this API.

Return Value

1 => file successfully deleted

<0 => TMEX File Operations Error Return Code

Code Example

See Also

TMCreateFile