Functions

UnsanitySCR_IsMatchSpecifierRegistered

Query whether the match specifier is registered with the Smart Crash Reports system.

UnsanitySCR_RegisterMatchSpecifier

Registers your match specifier with the Smart Crash Reports system.

UnsanitySCR_UnregisterMatchSpecifier

Unregisters your product(s) with the Smart Crash Reports system.

Query whether the match specifier is registered with the Smart Crash Reports system.

int UnsanitySCR_IsMatchSpecifierRegistered(
    CFStringRef inMatchString,
    CFStringRef*outOptionalRealMatchString); 

Parameter Descriptions

inMatchString

The match string to query for. Note that SCR will perform partial matches search, too, so for example if you have "com.mycompany" registered, and you query against "com.mycompany.otherapp", this function will return positive result.

outOptionalRealMatchString

If not NULL, this variable will contain the "real" match string that SCR contains in the database. You can use it in calls to UnsanitySCR_UnregisterProduct later, if you want. Important: You are responsible for releasing this value, if you have requested it, and the function returns 1.

function result

• 0: The match string you have provided is not registered with SCR.
• 1: The match string you have provided is registered with SCR.
• -1: inMatchString is NULL

Discussion

Queries whether the product is registered with the Smart Crash Reports system.

Registers your match specifier with the Smart Crash Reports system.

OSStatus UnsanitySCR_RegisterMatchSpecifier(
    CFStringRef inMatchString,
    CFStringRef inCompanyName,
    CFStringRef inSubmissionURL,
    CFStringRef inSubmissionEmailTicket,
    CFStringRef inOptionalCommentsTemplate); 

Parameter Descriptions

inMatchString

The product ID string to match or NULL to use the current bundle identifier. Normally, this is a part of a CFBundleIdentifier of your product. For example, if your product CFBundleIdentifier is "com.mycompany.myapp", it is a good idea to set inProductIDMatchString to "com.mycompany.", since it will catch all of the products of your company. If you pass NULL to this argument, an attempt to use CFBundleIdentifier from the main bundle will be used, which is handy for most applications out there, but not acceptable for Contextual Menu Modules, Preference Panes and other plugins.

inCompanyName

The company name in user-readable format. Smart Crash Reports will substitute "Apple" with this string, so make sure it's not too long. Example: "My Company"

inSubmissionURL

The full URL to the script on your Web server that will handle the submissions, or NULL if you prefer the crash report to be sent to you via email (in this case, inSubmissionEmail must be not NULL). Example: "http://www.mycompany.com/cgi-bin/processor.cgi"

inSubmissionEmailTicket

The email ticket for email you wish to receive crash report at, or NULL if you are handling it yourself on your web server. If this is set, Unsanity server will handle the submission and email you the crash log. Important: this is NOT the email address. It is a unique email ticket that you have to register with Unsanity by going to http://www.unsanity.com/goto/email-ticket/. This is done for email verification purposes, and also to not expose your real email to end users, if they peek inside of the SCR database somehow

inOptionalCommentsTemplate

If this argument is not NULL, this string will be inserted into the "Description" field of the CrashReporter dialog. This can be useful if you want to put something like "Put your email here if you wish to be contacted by the developer regarding this crash log", or anything else.

function result

One of the following:

• noErr: Registration successful. If there is already such a match specifier registered, it is replaced with the fresh information supplied to this call.
• paramErr: inSubmissionURL and inSubmissionEmailTicket are NULL, or inMatchString is NULL, or inCompanyName is NULL
• cNoMemErr: Not enough memory to perform selected operation.
• permErr: Not enough permissions to write changes to disk.
• bdNamErr: The match string is malformed, or too wide to be accepted (don't try to register "com.", etc!)

Discussion

Register your match specifier with the Smart Crash Reports system. Once this call is done, crash reports containing inMatchString in the crashed thread will be submitted to you, either to the submission URL (you have to implement the script on your web server), or to the submission email (Unsanity server will forward the report to you).

Unregisters your product(s) with the Smart Crash Reports system.

OSStatus UnsanitySCR_UnregisterMatchSpecifier(
    CFStringRef inMatchString); 

Parameter Descriptions

inMatchString

The match string to unregister. This must be the same match string as used in the UnsanitySCR_RegisterProduct call before.

function result

One of the following:

• noErr: Unregistration successful.
• paramErr: inMatchString is NULL
• cNoMemErr: Not enough memory to perform selected operation.
• permErr: Not enough permissions to write changes to disk.
• fnfErr: The provided inMatchString was not found in the Smart Crash Reports database. You can safely ignore this error, as it means that the match string you've provided does not exist already.

Discussion

Unregisters your product(s) with the Smart Crash Reports system. Performing this call will cause Smart Crash Reports to stop submitting bug reports for the inMatchString provided. Note that for this call to succeed, inMatchString must exactly match the one used in call to UnsanitySCR_RegisterProduct.

(Last Updated September 08, 2005)