Home » Development Area » DigiGuide Script » API Index » Function: GetProgrammeInfo

Function: GetProgrammeInfo

GetProgrammeInfo( int nProgramme, String text )

Summary

Get programme info in a specially tagged string.

Remarks

Parses text and replaces tags within it with the nProgramme related data.

So, if we passed text as "$ProgrammeName" then "Eastenders" could be returned. many tags can go into one call to GetProgrammeInfo. So, "$StartTime $ProgrammeName $CategoryName" is quite legal.

Passing nProgramme larger than the number of programmes available will result in an error being reported in the DebugOut

Parameters

Parameter	Description
int nProgramme	Programme index
String text	Tagged string

(Last updated: October 20, 2006 10:38:28)