ptCheckForPatch
Determine whether a patch is available for the current version and particular distribution of a product.
- PTBool ptCheckForPatch(
- int productID,
- const gsi_char * versionUniqueID,
- int distributionID,
- ptPatchCallback callback,
- PTBool blocking,
- void * instance );
| Routine | Required Header | Distribution |
|---|---|---|
| ptCheckForPatch | <pt.h> | SDKZIP |
Return Value
PTTrue is return if a query was sent. PTFalse means the operation was aborted.
Parameters
- productID
- [in] Numeric ID assigned by GameSpy. This is NOT the game ID.
- versionUniqueID
- [in] Developer specified string to indentify the current version. Typically "1.0" form.
- distributionID
- [in] Optional indentifier for distribution. This is usually 0.
- callback
- [in] Function to be called when the operation completes.
- blocking
- [in] When set to PTTrue, this function will not return until the operation has completed.
- instance
- [in] Pointer to user data. This is optional and will be passed unmodified to the callback function.
Remarks
The ptCheckForPatch function sends a query to determine if a patch is available for the current game version and distribution. If this function does not return PTFalse, then the callback will be called with information on a possible patch to a newer version.
Unicode Mappings
| Routine | GSI_UNICODE Not Defined | GSI_UNICODE Defined |
|---|---|---|
| ptCheckForPatch | ptCheckForPatchA | ptCheckForPatchW |
ptCheckForPatchW and ptCheckForPatchA are UNICODE and ANSI mapped versions of ptCheckForPatch. The arguments of ptCheckForPatchA are ANSI strings; those of ptCheckForPatchW are wide-character strings.
Section Reference: Gamespy Patching and Usage Analysis SDK