ClearPhysicalRecord

Unlocks a physical record and removes it from the log table

Local Servers:blocking
Remote Servers:blocking
Classification:3.x, 4.x, 5.x, 6.x
Service:Server-Based Synchronization

Syntax

  #include <\nlm\nit\nwsync.h>  
   
  int ClearPhysicalRecord (  
     int    fileHandle,  
     long   recordStartOffset,  
     long   recordLength);

Parameters

fileHandle
(IN) Specifies the handle of the file containing the record to be cleared.
recordStartOffset
(IN) Specifies the offset within the file where the record begins.
recordLength
(IN) Specifies the length of record in bytes.

Return Values

Decimal

Hex

Constant

0

(0x00)

ESUCCESS

255

(0xFF)

ERR_NO_RECORD_FOUND

Remarks

For cross-platform functionality, call NWClearPhysicalRecord.

The log table resides on the server and is associated exclusively with the requesting task.

The fileHandle value is returned by a previous call to open, sopen, creat, or fileno.

The application locates the beginning of the physical record within the specified file by passing an offset in recordStartOffset. The application specifies the length of a physical record by passing a length value in recordLength.

See Also

ClearPhysicalRecordSet, LockPhysicalRecordSet, LogPhysicalRecord, ReleasePhysicalRecord, ReleasePhysicalRecordSet