Naming conventions

This SDK documentation uses generic naming conventions for clarity across multiple languages and platforms. Developers must adapt these generic names to follow their programming language’s specific conventions.

Below are illustrative examples demonstrating the mapping from generic documentation to language-specific code:

Generic documentation

License.activateBuffer
VerificationResult.caCertificateVerified
LicenseError.invalidLicense

Language-specific implementations

This SDK complies with the PEP 8 recommendations.

  • Class, struct and enumeration names are written in PascalCase.

  • Class and struct member names are written in snake_case.

  • Enumeration fields are written in UPPER_CASE_WITH_UNDERSCORE.

Examples:

License.activate_buffer
VerificationResult.ca_certificate_verified
LicenseError.INVALID_LICENSE

  • Class, struct and enumeration names are written in PascalCase.

  • Class and struct member names are written in lowerCamelCase.

  • Enumeration fields are written in lowerCamelCase.

Examples:

License.activateBuffer
VerificationResult.caCertificateVerified
LicenseError.invalidLicense

  • Class, struct and enumeration names are written in PascalCase.

  • Class and struct member names are written in PascalCase.

  • Enumeration fields are written in PascalCase.

License.ActivateBuffer
VerificationResult.CaCertificateVerified
LicenseError.InvalidLicense

  • Class, struct and enumeration names are written in PascalCase.

  • Class and struct member names are written in lowerCamelCase.

  • Enumeration fields are written in UPPER_CASE_WITH_UNDERSCORE.

License.activateBuffer
VerificationResult.caCertificateVerified
LicenseError.INVALID_LICENSE

  • Class, struct and enumeration names are written in PascalCase.

  • Class and struct member names are written in lowerCamelCase.

  • Enumeration fields are written in UPPER_CASE_WITH_UNDERSCORE.

License.activateBuffer
VerificationResult.caCertificateVerified
LicenseError.INVALID_LICENSE

  • Class, struct and enumeration names are written in PascalCase.

  • Class and struct member names are written in lowerCamelCase.

  • Enumeration fields are written in lowerCamelCase.

License.activateBuffer
VerificationResult.caCertificateVerified
LicenseError.invalidLicense

id3License_ActivateBuffer
id3VerificationResult.CaCertificateVerified
id3LicenseError_InvalidLicense

Note

The C API implements pseudo object-oriented programming concepts where the object is passed explicitly to a member function as first parameter.