System information API

Includes:
"APSCommonServices.h"

Introduction

APIs for getting information about the system, such as device name, model, etc.



Functions

GetDeviceModelString

Gets the model string for the device (e.g. "Device1,1").

GetDeviceName

Gets the most user-friendly name available for the device.

GetPlatformMaxSocketBufferSize

Gets the maximum socket buffer size.


GetDeviceModelString


Gets the model string for the device (e.g. "Device1,1").

char * GetDeviceModelString(
    char *inBuf,
    size_t inMaxLen );  
Parameters
inBuf

Buffer to receive device model string. Must be at least inMaxLen bytes (includes null terminator).

inMaxLen

Number of bytes "inBuf" can hold. Includes the null terminator.

Return Value

Pointer to "inBuf".


GetDeviceName


Gets the most user-friendly name available for the device.

char * GetDeviceName(
    char *inBuf,
    size_t inMaxLen );  
Parameters
inBuf

Buffer to receive device name. Must be at least inMaxLen bytes (includes null terminator).

inMaxLen

Number of bytes "inBuf" can hold. Includes the null terminator.

Return Value

Pointer to "inBuf" or a constant, empty string if "inMaxLen" is 0.


GetPlatformMaxSocketBufferSize


Gets the maximum socket buffer size.

int GetPlatformMaxSocketBufferSize(
    int direction );  
Parameters
direction

direction for which size is being requested 1=for receiving data, 0=for sending data

Return Value

returns the maximum socket buffer size for the requested direction.


Typedefs