OBEXCreateVEvent

Function OBEXCreateVEvent 

Source
pub unsafe extern "C-unwind" fn OBEXCreateVEvent(
    in_charset: *const c_char,
    in_charset_length: u32,
    in_encoding: *const c_char,
    in_encoding_length: u32,
    in_event_start_date: *const c_char,
    in_event_start_date_length: u32,
    in_event_end_date: *const c_char,
    in_event_end_date_length: u32,
    in_alarm_date: *const c_char,
    in_alarm_date_length: u32,
    in_category: *const c_char,
    in_category_length: u32,
    in_summary: *const c_char,
    in_summary_length: u32,
    in_location: *const c_char,
    in_location_length: u32,
    in_xirmcluid: *const c_char,
    in_xirmcluid_length: u32,
) -> Option<CFRetained<CFData>>
👎Deprecated
Available on crate features OBEX and objc2-core-foundation only.
Expand description

Creates a formatted vEvent, ready to be sent over OBEX or whatever. You probably will embed the output in a vCalendar event.

Parameter inCharset: The Charset the passed data is in. Pass in a #defined charset for ease of use.

Parameter inCharsetLength: The length of the Charset passed data.

Parameter inEncoding: The encoding of the summary and location fields.

Parameter inEncodingLength: The length of the Charset passed data.

Parameter inEventStartDate: Start of event date, in the (ISO8601) format: YYYYMMDDTHHMMSS. e.g. 19960415T083000 = 8:30 am on April 15, 1996. All time values should be in LOCAL time.

Parameter inEventStartDateLength: The length of the Charset passed data.

Parameter inEventEndDate: End of event date.

Parameter inEventEndDateLength: The length of the Charset passed data.

Parameter inAlarmDate: Date of Alarm for event, in the format: YYYYMMDDTHHMMSS.

Parameter inAlarmDateLength: The length of the Charset passed data.

Parameter inCategory: Category of event, such as “MEETING” or “PHONE CALL”.

Parameter inCategoryLength: The length of the Charset passed data.

Parameter inSummary: Summary of event. Max length is 36 bytes. Longer will result in a bad argument error.

Parameter inSummaryLength: The length of the Charset passed data.

Parameter inLocation: Summary of event. Max length is 20 bytes. Longer will result in a bad argument error.

Parameter inLocationLength: The length of the Charset passed data.

Parameter inXIRMCLUID: The IRMC Local Unique Identifier Label, max length 12 bytes. Longer will result in a bad argument error.

Parameter inXIRMCLUIDLength: The length of the Charset passed data.

Returns: A valid CFDataRef - nil if we failed.

All parameters are optional. The CFDataRef returned to you is NOT retained. Retain it if you want to keep it. Be aware that certain devices such as Ericsson phones MUST have certain fields, such as a start and end date.

** DEPRECATED IN BLUETOOTH 2.2 (Mac OS X 10.6) ** You should transition your code to Objective-C equivalents. ** This API may be removed any time in the future.

§Safety

  • in_charset must be a valid pointer.
  • in_encoding must be a valid pointer.
  • in_event_start_date must be a valid pointer.
  • in_event_end_date must be a valid pointer.
  • in_alarm_date must be a valid pointer.
  • in_category must be a valid pointer.
  • in_summary must be a valid pointer.
  • in_location must be a valid pointer.
  • in_xirmcluid must be a valid pointer.