Skip to content

Latest commit

 

History

History
47 lines (28 loc) · 1.41 KB

f_setplatform.md

File metadata and controls

47 lines (28 loc) · 1.41 KB

f_SetPlatform

Description

Enables or disables platform-specific services. The platform service is implemented through the n_cst_platform user object and its descendants.

On Windows, when the application uses a Unicode character set, this function creates n_cst_platformunicode, a descendant of n_cst_platform. Otherwise it creates n_cst_platform.

Access

Public

Syntax

f_SetPlatform ( platformservice, boolean )
Argument Description
platformservice N_cst_platform variable into which the function creates the platform-specific n_cst_platform descendant
boolean Boolean specifying whether to create an instance of n_cst_platform (TRUE) or destroy an instance of n_cst_platform (FALSE).

Return value

Integer. Returns 1 if the function succeeds and -1 if an error occurs.

Usage

Call this function to enable and disable the platform service.

These objects contain functions that make external function calls to return operating system-specific information and play sounds.

Examples

This example enables the platform service. It assumes an inv_platform instance variable:

f_SetPlatform(inv_platform, TRUE)

See also