TMFormat Overview Group

The TMFormat API call writes an empty directory into the current device on the 1-Wire network specified by the session handle 'session_handle'.


short far pascal TMFormat(

long session_handle,    // session handle for the desired 1-Wire network
void far *state_buffer  // state buffer provided for the 1-Wire network session
);

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.

Return Value

1 => 1-Wire device successfully formatted

<0 => TMEX File Operations Error Return Code

Code Example

See Also

TMFirstFile