Platform SDK: Broadcast Architecture

CDatabaseRecordset::GetRecord

The GetRecord method returns a record object. C syntax is shown.

void *GetRecord(
  LONG RecordNumber  
);

Parameters

RecordNumber
Zero-based index of the record to retrieve from the recordset. This index number cannot be greater than the return value of the GetRecordCount method – 1.

Return Values

Returns a void pointer that receives the record object. Your application should cast this void pointer to the appropriate object type before it can access the record.

Remarks

The object GetRecord returns contains information corresponding to a single record for the appropriate table in the Guide database. For example, if your application calls the GetRecord method of a CEpisodeTRecordset object, an episode record object is returned. Thus, your application should cast the void pointer returned by CEpisodeTRecordset::GetRecord to a CEpisodeT pointer.

Once GetRecord returns the record object, your application can use the methods of the record object to retrieve and set field values for that record.

When the record object is no longer needed, your application should destroy it.

Requirements

  Windows NT/2000: Unsupported.
  Windows 95/98: Requires Windows 98.
  Header: Declared in dbsets.h.
  Import Library: Use dbsets.lib or dbsetsst.lib.

See Also

CDatabaseRecordset::GetRecordCount