ScheduleEvent.GetExtendedProperty Method
Gets the value of a specified property for the current scheduled recording event.
Syntax
public object GetExtendedProperty(
string name
);
Parameters
name
System.String. The name of the property to retrieve. The following properties can be retrieved:
Name | Description | Object type |
Title | Title of the scheduled recording event. | string |
ServiceID | Unique identifier representing the broadcast service. | string |
ChannelID | Unique identifier representing the channel. | string |
Description | Description of the program that is being recorded. | string |
KeepUntil | Indicates how long to keep the recorded file from this TV recording event. The following values are possible:
-2: Keep until I watch -1: Keep until space needed 0: Keep until I delete 1 or more: Number of days to keep |
int |
Quality | The recording quality, which can be one of the following values:
0: Fair 1: Good 2: Better 3: Best |
int |
Partial | Indicates whether the recording is incomplete. "True" indicates the program has been partially recorded or the recording has started later in the program. | bool |
ProviderCopyright | Copyright information from the provider. | string |
OriginalAirDate | The original air date of the program. | DateTime |
Repeat | Indicates whether the airing of a program is a repeat airing. If the current air date is more than one week after the original air date, this value is True. | bool |
Genre | Genre of this program. This information is provided by the Electronic Program Guide and the categorization is subject to change. | string |
FileName | The path of the recording file. This value is empty before the recording starts. | string |
Return Value
System.Object. The object representing the property. The object type depends on the property. If the specified property does not exist, this method returns null. This method raises an ArgumentNullException if the name is null. This method raises an ExtendedPropertyExceededLimitException if the property data was queried too many times recently. This method raises an EventScheduleException for any other errors.
Remarks
An ExtendedPropertyExceededLimitException is thrown for "Title" and "Description" properties of scheduled recording events after the number of queries to those properties exceeds about 1200 times in one day.
Requirements
Reference: ehRecObj
Namespace: Microsoft.MediaCenter.TV.Scheduling
Assembly: ehRecObj.dll
Platform: Windows Vista Ultimate, Windows Vista Home Premium, and later
See Also