# GetSocketString

## Description

Will read a string from the socket connection and return it. If you are sending a string from a source other than AGK then the string must begin with a 4 byte length value followed by X bytes of string data, where X is the length value. The string should not be null terminated. If there is less than 4 bytes of data waiting to be read then this command will return immediately and return an empty string. You can check how much data there is to read by using GetSocketBytesAvailable. If there are 4 or more bytes waiting to be read then this command will wait until the entire string has been received before returning.

## Definition

string GetSocketString( socketID )

char* agk::GetSocketString( UINT socketID )

## Parameters

- socketID - The ID of the socket to read